annotate jbrowse2/jbrowse2.xml @ 10:0db895a99532 draft default tip

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