annotate jbrowse2/jbrowse2.xml @ 0:cd5d63cd0eb5 draft

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