annotate jbrowse2/jbrowse2.xml @ 9:6a41f87b5d7f draft

Uploaded
author fubar
date Fri, 05 Jan 2024 05:06:21 +0000
parents 234cf4490901
children 0db895a99532
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
1 <tool id="jbrowse2" name="JBrowse2" version="@TOOL_VERSION@+@WRAPPER_VERSION@" profile="22.05">
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
2 <description>genome browser</description>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
3 <macros>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
4 <import>macros.xml</import>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
5 </macros>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
6 <expand macro="edamInc"/>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
7 <xrefs>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
8 <xref type="bio.tools">jbrowse2</xref>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
9 </xrefs>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
10 <expand macro="requirements"/>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
11 <version_command>python '${__tool_directory__}/jbrowse2.py' --version</version_command>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
12 <command detect_errors="aggressive"><![CDATA[
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
13 mkdir -p '$output.files_path' &&
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
14 ## Copy the XML file into the directory, mostly for debugging
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
15 ## but nice if users want to reproduce locally
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
16 cp '$trackxml' '$output.files_path/galaxy.xml' &&
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
17
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
18 export JBROWSE_SOURCE_DIR=\$(dirname \$(which jbrowse))/../opt/jbrowse2 &&
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
19
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
20 ## Once that's done, we run the python script to handle the real work
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
21 python '$__tool_directory__/jbrowse2.py'
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
22
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
23 --jbrowse \${JBROWSE_SOURCE_DIR}
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
24
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
25 --outdir '$output.files_path'
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
26 '$trackxml' &&
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
27
7
234cf4490901 Uploaded
fubar
parents: 6
diff changeset
28 cp '$output.files_path/index.html' '$output'
0
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
29
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
30 ## Ugly testing hack since I cannot get <extra_files> to test the files I want to test. Hmph.
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
31 #if str($uglyTestingHack) == "enabled":
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
32 && cp '$trackxml' '$output'
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
33 #end if
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
34 ]]></command>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
35 <configfiles>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
36 <configfile name="dummyIndex"><![CDATA[
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
37 <html>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
38 <head>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
39 </head>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
40 <body>
4
52842c3f2dda Uploaded
fubar
parents: 0
diff changeset
41 <h1>JBrowse2 Data Directory</h1>
0
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
42 <p>
4
52842c3f2dda Uploaded
fubar
parents: 0
diff changeset
43 Hi! This is not a full JBrowse2 instance. JBrowse v0.4(+?)
0
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
44 started shipping with the ability to produce just the
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
45 "data" directory from a JBrowse instance, rather than a
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
46 complete, standalone instance. This was intended to be used
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
47 with the in-development Apollo integration, but may have other
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
48 uses as well.
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
49 </p>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
50 </body>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
51 </html>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
52 ]]></configfile>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
53 <configfile name="trackxml"><![CDATA[<?xml version="1.0"?>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
54 <root>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
55 <metadata>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
56 <genomes>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
57 #if str($reference_genome.genome_type_select) == "indexed":
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
58 <genome path="${reference_genome.genome.fields.path}">
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
59 <metadata>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
60 <dataset id="${__app__.security.encode_id($dataset.id)}" hid="${dataset.hid}"
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
61 size="${dataset.get_size(nice_size=True)}"
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
62 edam_format="${dataset.datatype.edam_format}"
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
63 file_ext="${dataset.ext}" />
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
64 </metadata>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
65 </genome>
6
88b9b105c09b Uploaded
fubar
parents: 5
diff changeset
66 #else:
0
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
67 <genome path="$reference_genome.genome">
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
68 <metadata>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
69 <dataset id="${__app__.security.encode_id($reference_genome.genome.id)}" hid="${reference_genome.genome.hid}"
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
70 size="${reference_genome.genome.get_size(nice_size=True)}"
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
71 edam_format="${reference_genome.genome.datatype.edam_format}"
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
72 file_ext="${reference_genome.genome.ext}"
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
73 dname="${reference_genome.genome.element_identifier}" />
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
74 <history id="${__app__.security.encode_id($reference_genome.genome.history_id)}"
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
75 #if $reference_genome.genome.history.user:
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
76 user_email="${reference_genome.genome.history.user.email}"
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
77 user_id="${reference_genome.genome.history.user_id}"
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
78 display_name="${reference_genome.genome.history.get_display_name()}"/>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
79 #else
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
80 user_email="anonymous"
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
81 user_id="-1"
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
82 display_name="Unnamed History"
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
83 />
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
84 #end if
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
85 <metadata
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
86 #for (key, value) in $reference_genome.genome.get_metadata().items():
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
87 #if "_types" not in $key:
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
88 ${key}="${value}"
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
89 #end if
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
90 #end for
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
91 />
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
92 <tool
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
93 tool_id="${reference_genome.genome.creating_job.tool_id}"
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
94 tool_version="${reference_genome.genome.creating_job.tool_version}"
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
95 />
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
96 </metadata>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
97 </genome>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
98 #end if
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
99 </genomes>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
100 <galaxyUrl>${__app__.config.galaxy_infrastructure_url}</galaxyUrl>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
101 </metadata>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
102 <tracks>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
103 #for $tg in $track_groups:
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
104 #for $track in $tg.data_tracks:
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
105 <track cat="${tg.category}" format="${track.data_format.data_format_select}" >
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
106 #if $track.data_format.data_format_select != "rest" and $track.data_format.data_format_select != "sparql":
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
107 <files>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
108 #for $dataset in $track.data_format.annotation:
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
109 <trackFile path="${dataset}" ext="${dataset.ext}" label="${dataset.element_identifier}">
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
110 <metadata>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
111 <dataset id="${__app__.security.encode_id($dataset.id)}" hid="${dataset.hid}"
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
112 size="${dataset.get_size(nice_size=True)}"
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
113 edam_format="${dataset.datatype.edam_format}"
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
114 file_ext="${dataset.ext}" />
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
115 <history id="${__app__.security.encode_id($dataset.history_id)}"
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
116 #if $dataset.history.user:
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
117 user_email="${dataset.history.user.email}"
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
118 user_id="${dataset.history.user_id}"
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
119 display_name="${dataset.history.get_display_name()}"/>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
120 #else
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
121 user_email="anonymous"
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
122 user_id="-1"
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
123 display_name="Unnamed History"/>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
124 #end if
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
125 <metadata
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
126 #for (key, value) in $dataset.get_metadata().items():
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
127 #if "_types" not in $key and $value is not None and len(str($value)) < 5000:
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
128 ${key}="${value}"
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
129 #end if
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
130 #end for
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
131 />
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
132 <tool
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
133 tool_id="${dataset.creating_job.tool_id}"
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
134 tool_version="${dataset.creating_job.tool_version}"
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
135 />
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
136 </metadata>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
137 </trackFile>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
138 #end for
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
139 </files>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
140 #end if
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
141
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
142 <options>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
143 #if str($track.data_format.data_format_select) == "gene_calls" or str($track.data_format.data_format_select) == "blast" :
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
144 <style>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
145 <className>${track.data_format.jbstyle.style_classname}</className>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
146 <description>${track.data_format.jbstyle.style_description}</description>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
147 <label>${track.data_format.jbstyle.style_label}</label>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
148 <height>${track.data_format.jbstyle.style_height}</height>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
149 <maxHeight>${track.data_format.jbstyle.max_height}</maxHeight>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
150 </style>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
151 #else if str($track.data_format.data_format_select) == "pileup":
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
152 <pileup>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
153 <bam_indices>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
154 #for $dataset in $track.data_format.annotation:
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
155 <bam_index>${dataset.metadata.bam_index}</bam_index>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
156 #end for
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
157 </bam_indices>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
158 <chunkSizeLimit>${track.data_format.chunkSizeLimit}</chunkSizeLimit>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
159 </pileup>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
160 #end if
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
161 #if str($track.data_format.data_format_select) == "blast":
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
162 <blast>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
163 #if str($track.data_format.blast_parent) != "":
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
164 <parent>${track.data_format.blast_parent}</parent>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
165 #end if
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
166 <protein>${track.data_format.is_protein}</protein>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
167 <min_gap>${track.data_format.min_gap}</min_gap>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
168 <index>${track.data_format.index}</index>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
169 </blast>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
170 #end if
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
171 </options>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
172 </track>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
173 #end for
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
174 #end for
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
175 </tracks>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
176 <plugins>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
177 </plugins>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
178 </root>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
179 ]]></configfile>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
180 </configfiles>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
181 <inputs>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
182 <conditional name="reference_genome">
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
183 <param help="Built-in references" label="Reference genome to display" name="genome_type_select" type="select">
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
184 <option selected="True" value="indexed">Use a built-in genome</option>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
185 <option value="history">Use a genome from history</option>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
186 </param>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
187 <when value="indexed">
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
188 <param
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
189 help="If your genome of interest is not listed, contact the Galaxy team"
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
190 label="Select a reference genome"
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
191 name="genome"
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
192 type="select">
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
193 <options from_data_table="all_fasta">
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
194 <filter column="2" type="sort_by"/>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
195 <validator message="No genomes are available for the selected input dataset" type="no_options">
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
196 </validator>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
197 </options>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
198 </param>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
199 </when>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
200 <when value="history">
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
201 <param
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
202 format="fasta"
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
203 label="Select the reference genome"
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
204 name="genome"
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
205 type="data">
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
206 </param>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
207 </when>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
208 </conditional>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
209
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
210 <repeat name="track_groups" title="Track Group">
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
211 <param label="Track Category"
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
212 name="category"
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
213 type="text"
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
214 value="Default"
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
215 help="Organise your tracks into Categories for a nicer end-user experience. You can use #date# and it will be replaced with the current date in 'yyyy-mm-dd' format, which is very useful for repeatedly updating a JBrowse instance when member databases / underlying tool versions are updated." optional="False">
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
216 </param>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
217 <repeat name="data_tracks" title="Annotation Track">
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
218 <conditional name="data_format" label="Track Options">
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
219 <param type="select" label="Track Type" name="data_format_select">
7
234cf4490901 Uploaded
fubar
parents: 6
diff changeset
220 <option value="blast">Blast XML track - converted to GFF with actual gaps between hits</option>
234cf4490901 Uploaded
fubar
parents: 6
diff changeset
221 <option value="gene_calls" selected="true">GFF/GFF3/BED feature tracks</option>
234cf4490901 Uploaded
fubar
parents: 6
diff changeset
222 <option value="hic">HiC binary data. Existing cool format must be converted to binary hic - hic_matrix will NOT work.</option>
234cf4490901 Uploaded
fubar
parents: 6
diff changeset
223 <option value="pileup">BAM Pileup track</option>
234cf4490901 Uploaded
fubar
parents: 6
diff changeset
224 <option value="vcf">VCF SNP annotation track</option>
234cf4490901 Uploaded
fubar
parents: 6
diff changeset
225 <option value="wiggle">BigWig XY track</option>
0
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
226 </param>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
227 <when value="hic">
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
228 <expand macro="input_conditional" label="HiC Track Data" format="hic" help="Cool files must be converted first with hicexplorer" />
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
229 </when>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
230 <when value="blast">
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
231 <expand macro="input_conditional" label="BlastXML Track Data" format="blastxml" />
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
232 <expand macro="track_styling"
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
233 classname="feature"
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
234 label="description"
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
235 description="Hit_titles"
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
236 height="600px"/>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
237 <param label="Features used in Blast Search"
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
238 help="in GFF3. This is used so we know where to map features. E.g. where results of which CDS Protein32 match up to. The query IDs in your blast results should MATCH some feature IDs in your GFF3 file. This is an optional field and is most useful if using JBrowse to display protein blast results on a DNA genome. blastn results don't need this, blastp results on a protein sequence don't need this."
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
239 format="gff3"
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
240 name="blast_parent"
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
241 optional="true"
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
242 type="data"/>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
243
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
244 <param label="Minimum Gap Size"
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
245 help="before a new match_part feature is created"
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
246 name="min_gap"
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
247 type="integer"
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
248 value="10"
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
249 min="2" />
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
250 <param label="Is this a protein blast search?"
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
251 type="boolean"
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
252 name="is_protein"
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
253 truevalue="true"
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
254 falsevalue="false" />
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
255
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
256 <param label="Index this track" name="index" type="boolean" checked="false" truevalue="true" falsevalue="false" />
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
257 </when>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
258 <when value="vcf">
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
259 <expand macro="input_conditional" label="SNP Track Data" format="vcf" />
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
260 </when>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
261 <when value="gene_calls">
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
262 <expand macro="input_conditional" label="GFF/GFF3/BED Track Data" format="gff,gff3,bed" />
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
263 <expand macro="track_styling"
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
264 classname="feature"
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
265 label="product,name,id"
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
266 description="note,description"
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
267 height="10px"/>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
268 <conditional name="match_part" label="match/match_part data">
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
269 <param type="select" label="Match part" name="matchp">
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
270 <option value="false" selected="True">"No"</option>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
271 <option value="true">"Yes"</option>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
272 </param>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
273 <when value="true">
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
274 <param label="Match Part Feature Type"
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
275 name="name"
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
276 type="text"
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
277 value="match"
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
278 help="Match_parts have several options for the parent feature type, such as cDNA_match, match, translated_nucleotide_match, etc. Please select the appropriate one here. You can leave empty to try autodetection (only works with CanvasFeatures track type)."
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
279 optional="True"/>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
280 </when>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
281 <when value="false" />
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
282 </conditional>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
283 </when>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
284 <when value="pileup">
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
285 <expand macro="input_conditional" label="BAM Track Data" format="bam" />
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
286 <param type="select" label="Autogenerate SNP Track"
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
287 help="Not recommended for deep coverage BAM files" name="autogen">
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
288 <option value="false" selected="True">"No"</option>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
289 <option value="true">"Yes"</option>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
290 </param>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
291 <param label="Maximum size of BAM chunks"
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
292 name="chunkSizeLimit"
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
293 type="integer"
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
294 help="Maximum size in bytes of BAM chunks that the browser will try to deal with. When this is exceeded, most tracks will display 'Too much data' message."
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
295 value="5000000" />
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
296 </when>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
297 <when value="wiggle">
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
298 <expand macro="input_conditional" label="BigWig Track Data" format="bigwig" />
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
299 </when>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
300 </conditional>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
301 </repeat>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
302 </repeat>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
303 <param type="hidden" name="uglyTestingHack" value="" />
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
304 </inputs>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
305 <outputs>
7
234cf4490901 Uploaded
fubar
parents: 6
diff changeset
306 <data format="html" name="output" label="JBrowse2 on $reference_genome.genome.element_identifier"/>
0
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
307 </outputs>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
308 <tests>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
309 <test>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
310 <param name="reference_genome|genome_type_select" value="history"/>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
311 <param name="reference_genome|genome" value="merlin.fa"/>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
312 <param name="uglyTestingHack" value="enabled" />
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
313 <output name="output">
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
314 <assert_contents>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
315 <has_text text="genome path="></has_text>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
316 <has_text text="dataset id="></has_text>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
317 <has_text text="history id="></has_text>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
318 <has_text text="metadata"></has_text>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
319 <has_text text="tool_id"></has_text>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
320 </assert_contents>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
321 </output>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
322 </test>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
323 <test>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
324 <param name="reference_genome|genome_type_select" value="history"/>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
325 <param name="reference_genome|genome" value="merlin.fa"/>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
326 <repeat name="track_groups">
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
327 <param name="category" value="Default" />
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
328 <repeat name="data_tracks">
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
329 <conditional name="data_format">
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
330 <param name="data_format_select" value="gene_calls"/>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
331 <param name="annotation" value="bed/test-3.bed,bed/test-6.bed"/>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
332 </conditional>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
333 </repeat>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
334 </repeat>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
335 <param name="uglyTestingHack" value="enabled" />
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
336 <output name="output">
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
337 <assert_contents>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
338 <has_text text="genome path="></has_text>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
339 <has_text text="dataset id="></has_text>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
340 <has_text text="history id="></has_text>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
341 <has_text text="metadata"></has_text>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
342 <has_text text="tool_id"></has_text>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
343 <has_text text="ext=&quot;bed&quot; label=&quot;test-3.bed&quot;"></has_text>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
344 </assert_contents>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
345 </output>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
346 </test>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
347 <test>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
348 <conditional name="reference_genome">
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
349 <param name="genome_type_select" value="history"/>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
350 <param name="genome" value="merlin.fa"/>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
351 </conditional>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
352 <repeat name="track_groups">
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
353 <param name="category" value="Auto Coloured" />
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
354 <repeat name="data_tracks">
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
355 <conditional name="data_format">
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
356 <param name="data_format_select" value="pileup"/>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
357 <param name="annotation" value="bam/merlin-sample.bam"/>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
358 </conditional>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
359 </repeat>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
360 </repeat>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
361
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
362 <param name="uglyTestingHack" value="enabled" />
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
363 <output name="output">
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
364 <assert_contents>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
365 <has_text text="merlin-sample.bam"/>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
366 <has_text text="dname=&quot;merlin.fa&quot;"/>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
367 <has_text text="bam_index"/>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
368 </assert_contents>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
369 </output>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
370 </test>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
371
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
372 <test>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
373 <param name="reference_genome|genome_type_select" value="history"/>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
374 <param name="reference_genome|genome" value="merlin.fa"/>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
375 <param name="uglyTestingHack" value="enabled" />
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
376 <output name="output">
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
377 <assert_contents>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
378 <has_text text="merlin.fa"/>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
379 </assert_contents>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
380 </output>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
381 </test>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
382
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
383 </tests>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
384 <help><![CDATA[
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
385
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
386 JBrowse2-in-Galaxy
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
387 ==================
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
388
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
389 JBrowse2-in-Galaxy offers a highly configurable, workflow-compatible
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
390 alternative to JBrowse1-in-Galaxy and Trackster.
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
391
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
392 Compared to JBrowse1-in-Galaxy, there is no support for alternative codons for unusual genomes,
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
393 and detailed track styling is not yet implemented. Send code.
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
394 JBrowse1 development has now ceased in favour of JBrowse2.
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
395
7
234cf4490901 Uploaded
fubar
parents: 6
diff changeset
396 Use and local viewing
234cf4490901 Uploaded
fubar
parents: 6
diff changeset
397 =====================
234cf4490901 Uploaded
fubar
parents: 6
diff changeset
398
234cf4490901 Uploaded
fubar
parents: 6
diff changeset
399 A JBrowse2 history item can be opened by viewing it (the "eye" icon).
234cf4490901 Uploaded
fubar
parents: 6
diff changeset
400 They can also be downloaded as archives ("floppy disk" icon) to share and for local viewing.
234cf4490901 Uploaded
fubar
parents: 6
diff changeset
401 One extra step is required before they can be viewed. A local python web server must be started using a script included in each archive.
9
6a41f87b5d7f Uploaded
fubar
parents: 7
diff changeset
402 Unzip the archive (*unzip [filename].zip*) and change to the first level directory. It contains a file named "servejb2.py"
7
234cf4490901 Uploaded
fubar
parents: 6
diff changeset
403
9
6a41f87b5d7f Uploaded
fubar
parents: 7
diff changeset
404 Assuming you have python3 installed, running:
7
234cf4490901 Uploaded
fubar
parents: 6
diff changeset
405
234cf4490901 Uploaded
fubar
parents: 6
diff changeset
406 *python3 servjb2.py*
234cf4490901 Uploaded
fubar
parents: 6
diff changeset
407
234cf4490901 Uploaded
fubar
parents: 6
diff changeset
408 will serve the unarchived JBrowse2 configuration, so it can be browsed by pointing a web browser to localhost:8080
0
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
409
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
410 Overview
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
411 --------
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
412
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
413 JBrowse is a fast, embeddable genome browser built completely with
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
414 JavaScript and HTML5.
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
415
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
416 The JBrowse-in-Galaxy (JiG) tool was written to help build complex
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
417 JBrowse installations straight from Galaxy, taking advantage of the
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
418 latest Galaxy features such as dataset collections, sections, and colour
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
419 pickers. It allows you to build up a JBrowse instance without worrying
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
420 about how to run the command line tools to format your data, and which
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
421 options need to be supplied and where. Additionally it comes with many
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
422 javascript functions to handle colouring of features which would be
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
423 nearly impossible to write without the assistance of this tool.
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
424
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
425 The JBrowse-in-Galaxy tool is maintained by `the Galaxy IUC
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
426 <https://github.com/galaxyproject/tools-iuc/issues>`__, who you can help you
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
427 with missing features or bugs in the tool.
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
428
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
429 Options
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
430 -------
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
431
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
432 The first option you encounter is the **Fasta Sequence(s)**. This option
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
433 now accepts multiple fasta files, allowing you to build JBrowse
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
434 instances that contain data for multiple genomes or chrosomomes
7
234cf4490901 Uploaded
fubar
parents: 6
diff changeset
435 (generally known as "landmark features" in gff3 terminology.)
0
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
436
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
437 **Track Groups** represent a set of tracks in a single category. These
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
438 can be used to let your users understand relationships between large
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
439 groups of tracks.
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
440
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
441 .. image:: sections.png
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
442
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
443 Annotation Tracks
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
444 -----------------
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
445
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
446 There are a few different types of tracks supported, each with their own
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
447 set of options:
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
448
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
449 GFF3/BED
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
450 ~~~~~~~~
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
451
7
234cf4490901 Uploaded
fubar
parents: 6
diff changeset
452 These are standard feature tracks. They usually highlight genes,
234cf4490901 Uploaded
fubar
parents: 6
diff changeset
453 mRNAs and other features of interest along a genomic region.
0
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
454
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
455 BAM Pileups
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
456 ~~~~~~~~~~~
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
457
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
458 We support BAM files and can automatically generate SNP tracks based on
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
459 that bam data.
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
460
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
461
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
462 BlastXML
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
463 ~~~~~~~~
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
464
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
465 .. image:: blast.png
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
466
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
467 JiG now supports both blastn and blastp datasets. JiG internally uses a
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
468 blastXML to gapped GFF3 tool to convert your blastxml datasets into a
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
469 format amenable to visualization in JBrowse. This tool is also
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
470 available separately from the IUC on the toolshed.
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
471
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
472 **Minimum Gap Size** reflects how long a gap must be before it becomes a
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
473 real gap in the processed gff3 file. In the picture above, various sizes
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
474 of gaps can be seen. If the minimum gap size was set much higher, say
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
475 100nt, many of the smaller gaps would disappear, and the features on
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
476 both sides would be merged into one, longer feature. This setting is
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
477 inversely proportional to runtime and output file size. *Do not set this
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
478 to a low value for large datasets*. By setting this number lower, you
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
479 will have extremely large outputs and extremely long runtimes. The
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
480 default was configured based off of the author's experience, but the
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
481 author only works on small viruses. It is *strongly* recommended that
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
482 you filter your blast results before display, e.g. picking out the top
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
483 10 hits or so.
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
484
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
485 **Protein blast search** option merely informs underlying tools that
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
486 they should adjust feature locations by 3x.
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
487
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
488 Bigwig XY
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
489 ~~~~~~~~~
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
490
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
491 .. image:: bigwig.png
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
492
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
493
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
494
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
495 VCFs/SNPs
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
496 ~~~~~~~~~
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
497
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
498 These tracks do not support any special configuration.
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
499
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
500 @ATTRIBUTION@
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
501 ]]></help>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
502 <expand macro="citations"/>
cd5d63cd0eb5 Uploaded
fubar
parents:
diff changeset
503 </tool>