Mercurial > repos > yating-l > jbrowsearchivecreator

annotate README.md @ 19:62dee5369e80 draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload for repository https://github.com/goeckslab/jbrowse-archive-creator.git commit afd782e8741a859506794bea92475f620265c50e
author sargentl
date Thu, 13 Sep 2018 17:43:23 -0400
parents 43a700afd457
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
ac83821b0e06 planemo upload for repository https://github.com/Yating-L/jbrowse_hub commit bd7c7df707bfbcfa317c30caed48734d027dd889-dirty
yating-l
parents:
diff changeset
1 # JBrowse Hub Creator
13
43a700afd457 planemo upload for repository https://github.com/goeckslab/jbrowse-archive-creator.git commit bcb239c4045d2c47a8acad5fbd29eea03663e187
yating-l
parents: 6
diff changeset
2 This Galaxy tool is used to prepare your files to be ready for JBrowse visualization.
1
ac83821b0e06 planemo upload for repository https://github.com/Yating-L/jbrowse_hub commit bd7c7df707bfbcfa317c30caed48734d027dd889-dirty
yating-l
parents:
diff changeset
3
ac83821b0e06 planemo upload for repository https://github.com/Yating-L/jbrowse_hub commit bd7c7df707bfbcfa317c30caed48734d027dd889-dirty
yating-l
parents:
diff changeset
4 ## Features
ac83821b0e06 planemo upload for repository https://github.com/Yating-L/jbrowse_hub commit bd7c7df707bfbcfa317c30caed48734d027dd889-dirty
yating-l
parents:
diff changeset
5 1. Similar interface to Hub Archive Creator.
ac83821b0e06 planemo upload for repository https://github.com/Yating-L/jbrowse_hub commit bd7c7df707bfbcfa317c30caed48734d027dd889-dirty
yating-l
parents:
diff changeset
6 2. Convert tracks to GFF3 datatypes (e.g Blastxml => GFF3) in order to import feature data from the flat files
6
237707a6b74d planemo upload for repository https://github.com/Yating-L/jbrowse-archive-creator.git commit a500f7ab2119cc5faaf80393bd87428389d06880-dirty
yating-l
parents: 1
diff changeset
7 3. Group the tracks
237707a6b74d planemo upload for repository https://github.com/Yating-L/jbrowse-archive-creator.git commit a500f7ab2119cc5faaf80393bd87428389d06880-dirty
yating-l
parents: 1
diff changeset
8 4. Set the color for each track
237707a6b74d planemo upload for repository https://github.com/Yating-L/jbrowse-archive-creator.git commit a500f7ab2119cc5faaf80393bd87428389d06880-dirty
yating-l
parents: 1
diff changeset
9 5. Set the label for each track
13
43a700afd457 planemo upload for repository https://github.com/goeckslab/jbrowse-archive-creator.git commit bcb239c4045d2c47a8acad5fbd29eea03663e187
yating-l
parents: 6
diff changeset
10 6. Support generating Tabix Indexed CanVasFeatures tracks
43a700afd457 planemo upload for repository https://github.com/goeckslab/jbrowse-archive-creator.git commit bcb239c4045d2c47a8acad5fbd29eea03663e187
yating-l
parents: 6
diff changeset
11 7. Create workflows within Galaxy to automatize pipeline analysis and get them ready to visualization inside JBrowse...in a few clicks!
1
ac83821b0e06 planemo upload for repository https://github.com/Yating-L/jbrowse_hub commit bd7c7df707bfbcfa317c30caed48734d027dd889-dirty
yating-l
parents:
diff changeset
12
ac83821b0e06 planemo upload for repository https://github.com/Yating-L/jbrowse_hub commit bd7c7df707bfbcfa317c30caed48734d027dd889-dirty
yating-l
parents:
diff changeset
13 At the moment, Supported datatypes are:
13
43a700afd457 planemo upload for repository https://github.com/goeckslab/jbrowse-archive-creator.git commit bcb239c4045d2c47a8acad5fbd29eea03663e187
yating-l
parents: 6
diff changeset
14 - BAM
43a700afd457 planemo upload for repository https://github.com/goeckslab/jbrowse-archive-creator.git commit bcb239c4045d2c47a8acad5fbd29eea03663e187
yating-l
parents: 6
diff changeset
15 - BED
43a700afd457 planemo upload for repository https://github.com/goeckslab/jbrowse-archive-creator.git commit bcb239c4045d2c47a8acad5fbd29eea03663e187
yating-l
parents: 6
diff changeset
16 - Generic BED
1
ac83821b0e06 planemo upload for repository https://github.com/Yating-L/jbrowse_hub commit bd7c7df707bfbcfa317c30caed48734d027dd889-dirty
yating-l
parents:
diff changeset
17 - Splice Junctions (BED 12+1)
ac83821b0e06 planemo upload for repository https://github.com/Yating-L/jbrowse_hub commit bd7c7df707bfbcfa317c30caed48734d027dd889-dirty
yating-l
parents:
diff changeset
18 - Simple Repeats (BED 4+12)
13
43a700afd457 planemo upload for repository https://github.com/goeckslab/jbrowse-archive-creator.git commit bcb239c4045d2c47a8acad5fbd29eea03663e187
yating-l
parents: 6
diff changeset
19 - BLAT alignment (BigPsl)
43a700afd457 planemo upload for repository https://github.com/goeckslab/jbrowse-archive-creator.git commit bcb239c4045d2c47a8acad5fbd29eea03663e187
yating-l
parents: 6
diff changeset
20 - BLAST alignment (BED 12+12)
1
ac83821b0e06 planemo upload for repository https://github.com/Yating-L/jbrowse_hub commit bd7c7df707bfbcfa317c30caed48734d027dd889-dirty
yating-l
parents:
diff changeset
21 - BigWig
13
43a700afd457 planemo upload for repository https://github.com/goeckslab/jbrowse-archive-creator.git commit bcb239c4045d2c47a8acad5fbd29eea03663e187
yating-l
parents: 6
diff changeset
22 - GFF3
43a700afd457 planemo upload for repository https://github.com/goeckslab/jbrowse-archive-creator.git commit bcb239c4045d2c47a8acad5fbd29eea03663e187
yating-l
parents: 6
diff changeset
23 - GTF
43a700afd457 planemo upload for repository https://github.com/goeckslab/jbrowse-archive-creator.git commit bcb239c4045d2c47a8acad5fbd29eea03663e187
yating-l
parents: 6
diff changeset
24 - Blast XML output
1
ac83821b0e06 planemo upload for repository https://github.com/Yating-L/jbrowse_hub commit bd7c7df707bfbcfa317c30caed48734d027dd889-dirty
yating-l
parents:
diff changeset
25
ac83821b0e06 planemo upload for repository https://github.com/Yating-L/jbrowse_hub commit bd7c7df707bfbcfa317c30caed48734d027dd889-dirty
yating-l
parents:
diff changeset
26 ## Installation:
13
43a700afd457 planemo upload for repository https://github.com/goeckslab/jbrowse-archive-creator.git commit bcb239c4045d2c47a8acad5fbd29eea03663e187
yating-l
parents: 6
diff changeset
27
43a700afd457 planemo upload for repository https://github.com/goeckslab/jbrowse-archive-creator.git commit bcb239c4045d2c47a8acad5fbd29eea03663e187
yating-l
parents: 6
diff changeset
28 **ToolShed Installation**:
1
ac83821b0e06 planemo upload for repository https://github.com/Yating-L/jbrowse_hub commit bd7c7df707bfbcfa317c30caed48734d027dd889-dirty
yating-l
parents:
diff changeset
29
13
43a700afd457 planemo upload for repository https://github.com/goeckslab/jbrowse-archive-creator.git commit bcb239c4045d2c47a8acad5fbd29eea03663e187
yating-l
parents: 6
diff changeset
30 - The JBrowse Archive Creator tool is published at [ToolShed Repository](https://toolshed.g2.bx.psu.edu/view/yating-l/jbrowsearchivecreator)
43a700afd457 planemo upload for repository https://github.com/goeckslab/jbrowse-archive-creator.git commit bcb239c4045d2c47a8acad5fbd29eea03663e187
yating-l
parents: 6
diff changeset
31
43a700afd457 planemo upload for repository https://github.com/goeckslab/jbrowse-archive-creator.git commit bcb239c4045d2c47a8acad5fbd29eea03663e187
yating-l
parents: 6
diff changeset
32 - Refer to [Installing Tools into Galaxy](https://galaxyproject.org/admin/tools/add-tool-from-toolshed-tutorial) tutorial if you want to learn how to install a tool from ToolShed.
43a700afd457 planemo upload for repository https://github.com/goeckslab/jbrowse-archive-creator.git commit bcb239c4045d2c47a8acad5fbd29eea03663e187
yating-l
parents: 6
diff changeset
33
1
ac83821b0e06 planemo upload for repository https://github.com/Yating-L/jbrowse_hub commit bd7c7df707bfbcfa317c30caed48734d027dd889-dirty
yating-l
parents:
diff changeset
34 ## Future
ac83821b0e06 planemo upload for repository https://github.com/Yating-L/jbrowse_hub commit bd7c7df707bfbcfa317c30caed48734d027dd889-dirty
yating-l
parents:
diff changeset
35 See [TODO.md](todo.md) for more information
ac83821b0e06 planemo upload for repository https://github.com/Yating-L/jbrowse_hub commit bd7c7df707bfbcfa317c30caed48734d027dd889-dirty
yating-l
parents:
diff changeset
36
ac83821b0e06 planemo upload for repository https://github.com/Yating-L/jbrowse_hub commit bd7c7df707bfbcfa317c30caed48734d027dd889-dirty
yating-l
parents:
diff changeset
37 ## Contribute
ac83821b0e06 planemo upload for repository https://github.com/Yating-L/jbrowse_hub commit bd7c7df707bfbcfa317c30caed48734d027dd889-dirty
yating-l
parents:
diff changeset
38
13
43a700afd457 planemo upload for repository https://github.com/goeckslab/jbrowse-archive-creator.git commit bcb239c4045d2c47a8acad5fbd29eea03663e187
yating-l
parents: 6
diff changeset
39 - Source Code: https://github.com/goeckslab/jbrowse-archive-creator.git
1
ac83821b0e06 planemo upload for repository https://github.com/Yating-L/jbrowse_hub commit bd7c7df707bfbcfa317c30caed48734d027dd889-dirty
yating-l
parents:
diff changeset
40
ac83821b0e06 planemo upload for repository https://github.com/Yating-L/jbrowse_hub commit bd7c7df707bfbcfa317c30caed48734d027dd889-dirty
yating-l
parents:
diff changeset
41 ## Support
ac83821b0e06 planemo upload for repository https://github.com/Yating-L/jbrowse_hub commit bd7c7df707bfbcfa317c30caed48734d027dd889-dirty
yating-l
parents:
diff changeset
42
ac83821b0e06 planemo upload for repository https://github.com/Yating-L/jbrowse_hub commit bd7c7df707bfbcfa317c30caed48734d027dd889-dirty
yating-l
parents:
diff changeset
43 If you are having issues, please let us know.
ac83821b0e06 planemo upload for repository https://github.com/Yating-L/jbrowse_hub commit bd7c7df707bfbcfa317c30caed48734d027dd889-dirty
yating-l
parents:
diff changeset
44
ac83821b0e06 planemo upload for repository https://github.com/Yating-L/jbrowse_hub commit bd7c7df707bfbcfa317c30caed48734d027dd889-dirty
yating-l
parents:
diff changeset
45 - For more information about how to use G-OnRamp:
ac83821b0e06 planemo upload for repository https://github.com/Yating-L/jbrowse_hub commit bd7c7df707bfbcfa317c30caed48734d027dd889-dirty
yating-l
parents:
diff changeset
46 - [Wilson Leung](wleung@wustl.edu) - Product owner and developer
13
43a700afd457 planemo upload for repository https://github.com/goeckslab/jbrowse-archive-creator.git commit bcb239c4045d2c47a8acad5fbd29eea03663e187
yating-l
parents: 6
diff changeset
47 - [Yating Liu](yliu41@wustl.edu) - Community manager and developer
1
ac83821b0e06 planemo upload for repository https://github.com/Yating-L/jbrowse_hub commit bd7c7df707bfbcfa317c30caed48734d027dd889-dirty
yating-l
parents:
diff changeset
48
ac83821b0e06 planemo upload for repository https://github.com/Yating-L/jbrowse_hub commit bd7c7df707bfbcfa317c30caed48734d027dd889-dirty
yating-l
parents:
diff changeset
49 - For more information about the project vision, or for partneship:
ac83821b0e06 planemo upload for repository https://github.com/Yating-L/jbrowse_hub commit bd7c7df707bfbcfa317c30caed48734d027dd889-dirty
yating-l
parents:
diff changeset
50 - [Elgin, Sarah](selgin@wustl.edu) - PI
ac83821b0e06 planemo upload for repository https://github.com/Yating-L/jbrowse_hub commit bd7c7df707bfbcfa317c30caed48734d027dd889-dirty
yating-l
parents:
diff changeset
51 - [Jeremy Goecks](jgoecks@gwu.edu) - PI
ac83821b0e06 planemo upload for repository https://github.com/Yating-L/jbrowse_hub commit bd7c7df707bfbcfa317c30caed48734d027dd889-dirty
yating-l
parents:
diff changeset
52
ac83821b0e06 planemo upload for repository https://github.com/Yating-L/jbrowse_hub commit bd7c7df707bfbcfa317c30caed48734d027dd889-dirty
yating-l
parents:
diff changeset
53 ## License
ac83821b0e06 planemo upload for repository https://github.com/Yating-L/jbrowse_hub commit bd7c7df707bfbcfa317c30caed48734d027dd889-dirty
yating-l
parents:
diff changeset
54
ac83821b0e06 planemo upload for repository https://github.com/Yating-L/jbrowse_hub commit bd7c7df707bfbcfa317c30caed48734d027dd889-dirty
yating-l
parents:
diff changeset
55 The project is licensed under the Academic Free License 3.0. See [LICENSE.txt](LICENSE.txt).