Skip to content

Commit c43f609

Browse files
committed
Update plugin URL and add footnote in README
Updated the plugin URL and added a footnote about the port.
1 parent efd75de commit c43f609

1 file changed

Lines changed: 10 additions & 6 deletions

File tree

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,6 @@
22

33
A viewer for multiple alignment format (MAF) files in JBrowse 2
44

5-
This is a port of the JBrowse 1 plugin https://github.com/cmdcolin/mafviewer to
6-
JBrowse 2
7-
85
![](img/1.png)
96

107
## Demo
@@ -15,9 +12,11 @@ https://jbrowse.org/code/jb2/main/?config=%2Fdemos%2Fmaf%2Fhg38%2Fdistconfig.jso
1512

1613
This plugin supports three input formats:
1714

18-
1. **BigMaf** - UCSC BigMaf format (.bb files)
15+
1. **BigMaf** - UCSC BigMaf format e.g. .bb/.bigMaf
16+
(https://genome.ucsc.edu/goldenpath/help/bigMaf.html)
1917
2. **MAF tabix** - bgzip-compressed MAF converted to BED format with tabix index
20-
3. **TAF (Taffy)** - bgzip-compressed TAF format with .tai index
18+
3. **TAF (Taffy)** - bgzip-compressed TAF format
19+
(https://github.com/ComparativeGenomicsToolkit/taffy)
2120

2221
## GUI usage (e.g. in JBrowse Desktop)
2322

@@ -41,7 +40,7 @@ Then use the custom "Add track workflow":
4140
"plugins": [
4241
{
4342
"name": "MafViewer",
44-
"url": "https://unpkg.com/jbrowse-plugin-mafviewer/dist/jbrowse-plugin-mafviewer.umd.production.min.js"
43+
"url": "https://jbrowse.org/plugins/jbrowse-plugin-mafviewer/dist/jbrowse-plugin-mafviewer.umd.production.min.js"
4544
}
4645
]
4746
}
@@ -260,3 +259,8 @@ short alignment blocks:
260259
taffy view -i file.maf | taffy norm | bgzip > out.taf.gz
261260
taffy index -i out.taf.gz
262261
```
262+
263+
## Footnote
264+
265+
This is a port of the JBrowse 1 plugin https://github.com/cmdcolin/mafviewer to
266+
JBrowse 2

0 commit comments

Comments
 (0)