Mercurial > repos > jjohnson > gatk2

comparison variant_annotator.xml @ 0:74c05070a3f8 draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Uploaded
author jjohnson
date Thu, 01 Nov 2012 13:53:22 -0400
parents
children 7533db8dfb5b
comparison
equal deleted inserted replaced
-1:000000000000 0:74c05070a3f8
1 <tool id="gatk2_variant_annotator" name="Variant Annotator" version="0.0.4">
2 <description></description>
3 <requirements>
4 <requirement type="package" version="2.2">gatk</requirement>
5 <requirement type="package" version="0.1.18">samtools</requirement>
6 </requirements>
7 <command interpreter="python">gatk2_wrapper.py
8 --max_jvm_heap_fraction "1"
9 --stdout "${output_log}"
10 #if str( $reference_source.input_bam ) != "None":
11 -d "-I" "${reference_source.input_bam}" "${reference_source.input_bam.ext}" "gatk_input"
12 #if str( $reference_source.input_bam.metadata.bam_index ) != "None":
13 -d "" "${reference_source.input_bam.metadata.bam_index}" "bam_index" "gatk_input" ##hardcode galaxy ext type as bam_index
14 #end if
15 #end if
16 -d "--variant" "${reference_source.input_variant}" "${reference_source.input_variant.ext}" "input_variant"
17 -p 'java
18 -jar "\$GATK2_PATH/GenomeAnalysisTK.jar"
19 ##--list
20 -T "VariantAnnotator"
21 \$GATK2_SITE_OPTIONS
22 ##--num_threads 4 ##hard coded, for now
23 ##-et "NO_ET" -K "\$GATK2_BASE/gatk2_key_file" ##ET no phone home
24 ##-log "${output_log}" ##don't use this to log to file, instead directly capture stdout
25 #if $reference_source.reference_source_selector != "history":
26 -R "${reference_source.ref_file.fields.path}"
27 #end if
28 -o "${output_vcf}"
29 #if str( $annotations_type.annotations_type_selector ) == "use_all_annotations":
30 --useAllAnnotations
31 #else:
32 #if $annotations_type.annotations:
33 #for $annotation in str( $annotations_type.annotations.fields.gatk_value ).split( ',' ):
34 --annotation "${annotation}"
35 #end for
36 #end if
37 #end if
38 #if $exclude_annotations:
39 #for $annotation in str( $exclude_annotations.fields.gatk_value ).split( ',' ):
40 --excludeAnnotation "${annotation}"
41 #end for
42 #end if
43 #for $additional_annotation in $additional_annotations:
44 --annotation "${additional_annotation.additional_annotation_name}"
45 #end for
46 '
47 #if $reference_source.input_variant_bti:
48 -d "--intervals" "${reference_source.input_variant}" "${reference_source.input_variant.ext}" "input_variant_bti"
49 #end if
50
51 #for $rod_binding in $comp_rod_bind:
52 -d "--comp:${rod_binding.comp_rod_name},%(file_type)s" "${rod_binding.comp_input_rod}" "${rod_binding.comp_input_rod.ext}" "input_comp_${rod_binding.comp_rod_name}"
53 #end for
54
55 #if str( $dbsnp_rod_bind_type.dbsnp_rod_bind_type_selector ) == 'set_dbsnp':
56 -d "--dbsnp:${dbsnp_rod_bind_type.dbsnp_rod_name},%(file_type)s" "${dbsnp_rod_bind_type.dbsnp_input_rod}" "${dbsnp_rod_bind_type.dbsnp_input_rod.ext}" "input_dbsnp_${dbsnp_rod_bind_type.dbsnp_rod_name}"
57 #end if
58
59
60 #for $rod_binding in $resource_rod_bind:
61 -d "--resource:${rod_binding.resource_rod_name},%(file_type)s" "${rod_binding.resource_input_rod}" "${rod_binding.resource_input_rod.ext}" "input_resource_${rod_binding.resource_rod_name}"
62 #end for
63
64 #if str( $snpEff_rod_bind_type.snpEff_rod_bind_type_selector ) == 'set_snpEff':
65 -p '--annotation "SnpEff"'
66 -d "--snpEffFile:${snpEff_rod_bind_type.snpEff_rod_name},%(file_type)s" "${snpEff_rod_bind_type.snpEff_input_rod}" "${snpEff_rod_bind_type.snpEff_input_rod.ext}" "input_snpEff_${snpEff_rod_bind_type.snpEff_rod_name}"
67 #else:
68 -p '--excludeAnnotation "SnpEff"'
69 #end if
70
71 #for $expression in $expressions:
72 -p '--expression "${expression.expression}"'
73 #end for
74
75 ##start standard gatk options
76 #if $gatk_param_type.gatk_param_type_selector == "advanced":
77 #for $pedigree in $gatk_param_type.pedigree:
78 -p '--pedigree "${pedigree.pedigree_file}"'
79 #end for
80 #for $pedigree_string in $gatk_param_type.pedigree_string_repeat:
81 -p '--pedigreeString "${pedigree_string.pedigree_string}"'
82 #end for
83 -p '--pedigreeValidationType "${gatk_param_type.pedigree_validation_type}"'
84 #for $read_filter in $gatk_param_type.read_filter:
85 -p '--read_filter "${read_filter.read_filter_type.read_filter_type_selector}"
86 ###raise Exception( str( dir( $read_filter ) ) )
87 #for $name, $param in $read_filter.read_filter_type.iteritems():
88 #if $name not in [ "__current_case__", "read_filter_type_selector" ]:
89 #if hasattr( $param.input, 'truevalue' ):
90 ${param}
91 #else:
92 --${name} "${param}"
93 #end if
94 #end if
95 #end for
96 '
97 #end for
98 #for $interval_count, $input_intervals in enumerate( $gatk_param_type.input_interval_repeat ):
99 -d "--intervals" "${input_intervals.input_intervals}" "${input_intervals.input_intervals.ext}" "input_intervals_${interval_count}"
100 #end for
101
102 #for $interval_count, $input_intervals in enumerate( $gatk_param_type.input_exclude_interval_repeat ):
103 -d "--excludeIntervals" "${input_intervals.input_exclude_intervals}" "${input_intervals.input_exclude_intervals.ext}" "input_exlude_intervals_${interval_count}"
104 #end for
105
106 -p '--interval_set_rule "${gatk_param_type.interval_set_rule}"'
107
108 -p '--downsampling_type "${gatk_param_type.downsampling_type.downsampling_type_selector}"'
109 #if str( $gatk_param_type.downsampling_type.downsampling_type_selector ) != "NONE":
110 -p '--${gatk_param_type.downsampling_type.downsample_to_type.downsample_to_type_selector} "${gatk_param_type.downsampling_type.downsample_to_type.downsample_to_value}"'
111 #end if
112 -p '
113 --baq "${gatk_param_type.baq}"
114 --baqGapOpenPenalty "${gatk_param_type.baq_gap_open_penalty}"
115 ${gatk_param_type.use_original_qualities}
116 --defaultBaseQualities "${gatk_param_type.default_base_qualities}"
117 --validation_strictness "${gatk_param_type.validation_strictness}"
118 --interval_merging "${gatk_param_type.interval_merging}"
119 ${gatk_param_type.disable_experimental_low_memory_sharding}
120 ${gatk_param_type.non_deterministic_random_seed}
121 '
122 #for $rg_black_list_count, $rg_black_list in enumerate( $gatk_param_type.read_group_black_list_repeat ):
123 #if $rg_black_list.read_group_black_list_type.read_group_black_list_type_selector == "file":
124 -d "--read_group_black_list" "${rg_black_list.read_group_black_list_type.read_group_black_list}" "txt" "input_read_group_black_list_${rg_black_list_count}"
125 #else
126 -p '--read_group_black_list "${rg_black_list.read_group_black_list_type.read_group_black_list}"'
127 #end if
128 #end for
129 #end if
130 #if str( $reference_source.reference_source_selector ) == "history":
131 -d "-R" "${reference_source.ref_file}" "${reference_source.ref_file.ext}" "gatk_input"
132 #end if
133 ##end standard gatk options
134
135 -p '
136 #if str( $annotation_group ) != "None":
137 #for $group in str( $annotation_group ).split( ',' ):
138 --group "${group}"
139 #end for
140 #end if
141 #if str( $family_string ) != "":
142 --family_string "${family_string}"
143 #end if
144 --MendelViolationGenotypeQualityThreshold "${mendel_violation_genotype_quality_threshold}"
145 '
146 </command>
147 <inputs>
148 <conditional name="reference_source">
149 <param name="reference_source_selector" type="select" label="Choose the source for the reference list">
150 <option value="cached">Locally cached</option>
151 <option value="history">History</option>
152 </param>
153 <when value="cached">
154 <param name="input_variant" type="data" format="vcf" label="Variant file to annotate" help="-V,--variant &amp;lt;variant&amp;gt;"/>
155 <param name="input_variant_bti" type="boolean" truevalue="-BTI variant" falsevalue="" label="Increase efficiency for small variant files." help="--intervals"/>
156 <param name="input_bam" type="data" format="bam" label="BAM file" optional="True" help="Not needed for all annotations. (-I,--input_file &amp;lt;input_file&amp;gt;)" >
157 <validator type="unspecified_build" />
158 <validator type="dataset_metadata_in_data_table" table_name="gatk2_picard_indexes" metadata_name="dbkey" metadata_column="dbkey" message="Sequences are not currently available for the specified build." /> <!-- fixme!!! this needs to be a select -->
159 </param>
160 <param name="ref_file" type="select" label="Using reference genome" help="-R,--reference_sequence &amp;lt;reference_sequence&amp;gt;">
161 <options from_data_table="gatk2_picard_indexes">
162 <filter type="data_meta" key="dbkey" ref="input_variant" column="dbkey"/>
163 </options>
164 <validator type="no_options" message="A built-in reference genome is not available for the build associated with the selected input file"/>
165 </param>
166 </when>
167 <when value="history"> <!-- FIX ME!!!! -->
168 <param name="input_variant" type="data" format="vcf" label="Variant file to annotate" help="-V,--variant &amp;lt;variant&amp;gt;"/>
169 <param name="input_variant_bti" type="boolean" truevalue="-BTI variant" falsevalue="" label="Increase efficiency for small variant files." help="--intervals"/>
170 <param name="input_bam" type="data" format="bam" label="BAM file" optional="True" help="Not needed for all annotations. (-I,--input_file &amp;lt;input_file&amp;gt;)" >
171 </param>
172 <param name="ref_file" type="data" format="fasta" label="Using reference file" help="-R,--reference_sequence &amp;lt;reference_sequence&amp;gt;" />
173 </when>
174 </conditional>
175 <conditional name="annotations_type">
176 <param name="annotations_type_selector" type="select" label="Use all possible annotations">
177 <option value="use_all_annotations">Use all</option>
178 <option value="choose" selected="True">Use selected</option>
179 </param>
180 <when value="use_all_annotations">
181 <!-- no extra options here -->
182 </when>
183 <when value="choose">
184 <param name="annotations" type="select" multiple="True" display="checkboxes" label="Annotations to apply" help="-A,--annotation &amp;lt;annotation&amp;gt;" >
185 <!-- load the available annotations from an external configuration file, since additional ones can be added to local installs -->
186 <options from_data_table="gatk2_annotations">
187 <filter type="multiple_splitter" column="tools_valid_for" separator=","/>
188 <filter type="static_value" value="VariantAnnotator" column="tools_valid_for"/>
189 </options>
190 </param>
191 </when>
192 </conditional>
193
194 <repeat name="additional_annotations" title="Additional annotation" help="-A,--annotation &amp;lt;annotation&amp;gt;">
195 <param name="additional_annotation_name" type="text" value="" label="Annotation name" />
196 </repeat>
197
198 <repeat name="comp_rod_bind" title="Binding for reference-ordered comparison data" help="-comp,--comp &amp;lt;comp&amp;gt;">
199 <param name="comp_input_rod" type="data" format="vcf" label="ROD file" />
200 <param name="comp_rod_name" type="text" value="Unnamed" label="ROD Name"/>
201 </repeat>
202
203 <conditional name="dbsnp_rod_bind_type">
204 <param name="dbsnp_rod_bind_type_selector" type="select" label="Provide a dbSNP reference-ordered data file" help="-D,--dbsnp &amp;lt;dbsnp&amp;gt;">
205 <option value="set_dbsnp" selected="True">Set dbSNP</option>
206 <option value="exclude_dbsnp">Don't set dbSNP</option>
207 </param>
208 <when value="exclude_dbsnp">
209 <!-- Do nothing here -->
210 </when>
211 <when value="set_dbsnp">
212 <param name="dbsnp_input_rod" type="data" format="vcf" label="ROD file" />
213 <param name="dbsnp_rod_name" type="hidden" value="dbsnp" label="ROD Name"/>
214 </when>
215 </conditional>
216
217 <repeat name="resource_rod_bind" title="Binding for reference-ordered resource data" help="-resource,--resource &amp;lt;resource&amp;gt;">
218 <param name="resource_input_rod" type="data" format="vcf" label="ROD file" />
219 <param name="resource_rod_name" type="text" value="Unnamed" label="ROD Name"/>
220 </repeat>
221
222 <conditional name="snpEff_rod_bind_type">
223 <param name="snpEff_rod_bind_type_selector" type="select" label="Provide a snpEff reference-ordered data file" help="-snpEffFile,--snpEffFile &amp;lt;snpEffFile&amp;gt;">
224 <option value="set_snpEff">Set snpEff</option>
225 <option value="exclude_snpEff" selected="True">Don't set snpEff</option>
226 </param>
227 <when value="exclude_snpEff">
228 <!-- Do nothing here -->
229 </when>
230 <when value="set_snpEff">
231 <param name="snpEff_input_rod" type="data" format="vcf" label="ROD file" />
232 <param name="snpEff_rod_name" type="hidden" value="snpEff" label="ROD Name"/>
233 </when>
234 </conditional>
235
236 <repeat name="expressions" title="Expression" help="-E,--expression &amp;lt;expression&amp;gt;">
237 <param name="expression" type="text" value="" label="Expression"/>
238 </repeat>
239
240 <conditional name="gatk_param_type">
241 <param name="gatk_param_type_selector" type="select" label="Basic or Advanced GATK options">
242 <option value="basic" selected="True">Basic</option>
243 <option value="advanced">Advanced</option>
244 </param>
245 <when value="basic">
246 <!-- Do nothing here -->
247 </when>
248 <when value="advanced">
249 <repeat name="pedigree" title="Pedigree file" help="-ped,--pedigree &amp;lt;pedigree&amp;gt;">
250 <param name="pedigree_file" type="data" format="txt" label="Pedigree files for samples"/>
251 </repeat>
252 <repeat name="pedigree_string_repeat" title="Pedigree string" help="-pedString,--pedigreeString &amp;lt;pedigreeString&amp;gt;">
253 <param name="pedigree_string" type="text" value="" label="Pedigree string for samples"/>
254 </repeat>
255 <param name="pedigree_validation_type" type="select" label="How strict should we be in validating the pedigree information" help="-pedValidationType,--pedigreeValidationType &amp;lt;pedigreeValidationType&amp;gt;">
256 <option value="STRICT" selected="True">STRICT</option>
257 <option value="SILENT">SILENT</option>
258 </param>
259 <repeat name="read_filter" title="Read Filter" help="-rf,--read_filter &amp;lt;read_filter&amp;gt;">
260 <conditional name="read_filter_type">
261 <param name="read_filter_type_selector" type="select" label="Read Filter Type">
262 <option value="BadCigar">BadCigar</option>
263 <option value="BadMate">BadMate</option>
264 <option value="DuplicateRead">DuplicateRead</option>
265 <option value="FailsVendorQualityCheck">FailsVendorQualityCheck</option>
266 <option value="MalformedRead">MalformedRead</option>
267 <option value="MappingQuality">MappingQuality</option>
268 <option value="MappingQualityUnavailable">MappingQualityUnavailable</option>
269 <option value="MappingQualityZero">MappingQualityZero</option>
270 <option value="MateSameStrand">MateSameStrand</option>
271 <option value="MaxInsertSize">MaxInsertSize</option>
272 <option value="MaxReadLength" selected="True">MaxReadLength</option>
273 <option value="MissingReadGroup">MissingReadGroup</option>
274 <option value="NoOriginalQualityScores">NoOriginalQualityScores</option>
275 <option value="NotPrimaryAlignment">NotPrimaryAlignment</option>
276 <option value="Platform454">Platform454</option>
277 <option value="Platform">Platform</option>
278 <option value="PlatformUnit">PlatformUnit</option>
279 <option value="ReadGroupBlackList">ReadGroupBlackList</option>
280 <option value="ReadName">ReadName</option>
281 <option value="ReadStrand">ReadStrand</option>
282 <option value="ReassignMappingQuality">ReassignMappingQuality</option>
283 <option value="Sample">Sample</option>
284 <option value="SingleReadGroup">SingleReadGroup</option>
285 <option value="UnmappedRead">UnmappedRead</option>
286 </param>
287 <when value="BadCigar">
288 <!-- no extra options -->
289 </when>
290 <when value="BadMate">
291 <!-- no extra options -->
292 </when>
293 <when value="DuplicateRead">
294 <!-- no extra options -->
295 </when>
296 <when value="FailsVendorQualityCheck">
297 <!-- no extra options -->
298 </when>
299 <when value="MalformedRead">
300 <!-- no extra options -->
301 </when>
302 <when value="MappingQuality">
303 <param name="min_mapping_quality_score" type="integer" value="10" label="Minimum read mapping quality required to consider a read for calling"/>
304 </when>
305 <when value="MappingQualityUnavailable">
306 <!-- no extra options -->
307 </when>
308 <when value="MappingQualityZero">
309 <!-- no extra options -->
310 </when>
311 <when value="MateSameStrand">
312 <!-- no extra options -->
313 </when>
314 <when value="MaxInsertSize">
315 <param name="maxInsertSize" type="integer" value="1000000" label="Discard reads with insert size greater than the specified value"/>
316 </when>
317 <when value="MaxReadLength">
318 <param name="maxReadLength" type="integer" value="76" label="Max Read Length"/>
319 </when>
320 <when value="MissingReadGroup">
321 <!-- no extra options -->
322 </when>
323 <when value="NoOriginalQualityScores">
324 <!-- no extra options -->
325 </when>
326 <when value="NotPrimaryAlignment">
327 <!-- no extra options -->
328 </when>
329 <when value="Platform454">
330 <!-- no extra options -->
331 </when>
332 <when value="Platform">
333 <param name="PLFilterName" type="text" value="" label="Discard reads with RG:PL attribute containing this string"/>
334 </when>
335 <when value="PlatformUnit">
336 <!-- no extra options -->
337 </when>
338 <when value="ReadGroupBlackList">
339 <!-- no extra options -->
340 </when>
341 <when value="ReadName">
342 <param name="readName" type="text" value="" label="Filter out all reads except those with this read name"/>
343 </when>
344 <when value="ReadStrand">
345 <param name="filterPositive" type="boolean" truevalue="--filterPositive" falsevalue="" label="Discard reads on the forward strand"/>
346 </when>
347 <when value="ReassignMappingQuality">
348 <param name="default_mapping_quality" type="integer" value="60" label="Default read mapping quality to assign to all reads"/>
349 </when>
350 <when value="Sample">
351 <param name="sample_to_keep" type="text" value="" label="The name of the sample(s) to keep, filtering out all others"/>
352 </when>
353 <when value="SingleReadGroup">
354 <param name="read_group_to_keep" type="integer" value="76" label="The name of the read group to keep, filtering out all others"/>
355 </when>
356 <when value="UnmappedRead">
357 <!-- no extra options -->
358 </when>
359 </conditional>
360 </repeat>
361 <repeat name="input_interval_repeat" title="Operate on Genomic intervals" help="-L,--intervals &amp;lt;intervals&amp;gt;">
362 <param name="input_intervals" type="data" format="bed,gatk_interval,picard_interval_list,vcf" label="Genomic intervals" />
363 </repeat>
364 <repeat name="input_exclude_interval_repeat" title="Exclude Genomic intervals" help="-XL,--excludeIntervals &amp;lt;excludeIntervals&amp;gt;">
365 <param name="input_exclude_intervals" type="data" format="bed,gatk_interval,picard_interval_list,vcf" label="Genomic intervals" />
366 </repeat>
367
368 <param name="interval_set_rule" type="select" label="Interval set rule" help="-isr,--interval_set_rule &amp;lt;interval_set_rule&amp;gt;">
369 <option value="UNION" selected="True">UNION</option>
370 <option value="INTERSECTION">INTERSECTION</option>
371 </param>
372
373 <conditional name="downsampling_type">
374 <param name="downsampling_type_selector" type="select" label="Type of reads downsampling to employ at a given locus" help="-dt,--downsampling_type &amp;lt;downsampling_type&amp;gt;">
375 <option value="NONE" selected="True">NONE</option>
376 <option value="ALL_READS">ALL_READS</option>
377 <option value="BY_SAMPLE">BY_SAMPLE</option>
378 </param>
379 <when value="NONE">
380 <!-- no more options here -->
381 </when>
382 <when value="ALL_READS">
383 <conditional name="downsample_to_type">
384 <param name="downsample_to_type_selector" type="select" label="Downsample method">
385 <option value="downsample_to_fraction" selected="True">Downsample by Fraction</option>
386 <option value="downsample_to_coverage">Downsample by Coverage</option>
387 </param>
388 <when value="downsample_to_fraction">
389 <param name="downsample_to_value" type="float" label="Fraction [0.0-1.0] of reads to downsample to" value="1" min="0" max="1" help="-dfrac,--downsample_to_fraction &amp;lt;downsample_to_fraction&amp;gt;"/>
390 </when>
391 <when value="downsample_to_coverage">
392 <param name="downsample_to_value" type="integer" label="Coverage to downsample to at any given locus" value="0" help="-dcov,--downsample_to_coverage &amp;lt;downsample_to_coverage&amp;gt;"/>
393 </when>
394 </conditional>
395 </when>
396 <when value="BY_SAMPLE">
397 <conditional name="downsample_to_type">
398 <param name="downsample_to_type_selector" type="select" label="Downsample method">
399 <option value="downsample_to_fraction" selected="True">Downsample by Fraction</option>
400 <option value="downsample_to_coverage">Downsample by Coverage</option>
401 </param>
402 <when value="downsample_to_fraction">
403 <param name="downsample_to_value" type="float" label="Fraction [0.0-1.0] of reads to downsample to" value="1" min="0" max="1" help="-dfrac,--downsample_to_fraction &amp;lt;downsample_to_fraction&amp;gt;"/>
404 </when>
405 <when value="downsample_to_coverage">
406 <param name="downsample_to_value" type="integer" label="Coverage to downsample to at any given locus" value="0" help="-dcov,--downsample_to_coverage &amp;lt;downsample_to_coverage&amp;gt;"/>
407 </when>
408 </conditional>
409 </when>
410 </conditional>
411 <param name="baq" type="select" label="Type of BAQ calculation to apply in the engine" help="-baq,--baq &amp;lt;baq&amp;gt;">
412 <option value="OFF" selected="True">OFF</option>
413 <option value="CALCULATE_AS_NECESSARY">CALCULATE_AS_NECESSARY</option>
414 <option value="RECALCULATE">RECALCULATE</option>
415 </param>
416 <param name="baq_gap_open_penalty" type="float" label="BAQ gap open penalty (Phred Scaled)" value="40" help="Default value is 40. 30 is perhaps better for whole genome call sets. -baqGOP,--baqGapOpenPenalty &amp;lt;baqGapOpenPenalty&amp;gt;" />
417 <param name="use_original_qualities" type="boolean" truevalue="--useOriginalQualities" falsevalue="" label="Use the original base quality scores from the OQ tag" help="-OQ,--useOriginalQualities" />
418 <param name="default_base_qualities" type="integer" label="Value to be used for all base quality scores, when some are missing" value="-1" help="-DBQ,--defaultBaseQualities &amp;lt;defaultBaseQualities&amp;gt;"/>
419 <param name="validation_strictness" type="select" label="How strict should we be with validation" help="-S,--validation_strictness &amp;lt;validation_strictness&amp;gt;">
420 <option value="STRICT" selected="True">STRICT</option>
421 <option value="LENIENT">LENIENT</option>
422 <option value="SILENT">SILENT</option>
423 <!-- <option value="DEFAULT_STRINGENCY">DEFAULT_STRINGENCY</option> listed in docs, but not valid value...-->
424 </param>
425 <param name="interval_merging" type="select" label="Interval merging rule" help="-im,--interval_merging &amp;lt;interval_merging&amp;gt;">
426 <option value="ALL" selected="True">ALL</option>
427 <option value="OVERLAPPING_ONLY">OVERLAPPING_ONLY</option>
428 </param>
429
430 <repeat name="read_group_black_list_repeat" title="Read group black list" help="-rgbl,--read_group_black_list &amp;lt;read_group_black_list&amp;gt;">
431 <conditional name="read_group_black_list_type">
432 <param name="read_group_black_list_type_selector" type="select" label="Type of reads read group black list">
433 <option value="file" selected="True">Filters in file</option>
434 <option value="text">Specify filters as a string</option>
435 </param>
436 <when value="file">
437 <param name="read_group_black_list" type="data" format="txt" label="Read group black list file" />
438 </when>
439 <when value="text">
440 <param name="read_group_black_list" type="text" value="tag:string" label="Read group black list tag:string" />
441 </when>
442 </conditional>
443 </repeat>
444
445 <param name="disable_experimental_low_memory_sharding" type="boolean" truevalue="--disable_experimental_low_memory_sharding" falsevalue="" label="Disable experimental low-memory sharding functionality." checked="False" help="--disable_experimental_low_memory_sharding"/>
446 <param name="non_deterministic_random_seed" type="boolean" truevalue="--nonDeterministicRandomSeed" falsevalue="" label="Makes the GATK behave non deterministically, that is, the random numbers generated will be different in every run" checked="False" help="-ndrs,--nonDeterministicRandomSeed"/>
447
448 </when>
449 </conditional>
450
451 <param name="annotation_group" type="select" multiple="True" display="checkboxes" label="annotation interfaces/groups to apply to variant calls" help="-G,--group &amp;lt;group&amp;gt;">
452 <option value="RodRequiringAnnotation">RodRequiringAnnotation</option>
453 <option value="Standard">Standard</option>
454 <option value="Experimental">Experimental</option>
455 <option value="WorkInProgress">WorkInProgress</option>
456 <option value="RankSumTest">RankSumTest</option>
457 </param>
458 <param name="family_string" type="text" value="" label="Family String" help="--family_string"/>
459 <param name="mendel_violation_genotype_quality_threshold" type="float" value="0.0" label="genotype quality treshold in order to annotate mendelian violation ratio." help="-mvq,--MendelViolationGenotypeQualityThreshold &amp;lt;MendelViolationGenotypeQualityThreshold&amp;gt;"/>
460 <param name="exclude_annotations" type="select" multiple="True" display="checkboxes" label="Annotations to exclude" help="-XA,--excludeAnnotation &amp;lt;excludeAnnotation&amp;gt;" >
461 <!-- load the available annotations from an external configuration file, since additional ones can be added to local installs -->
462 <options from_data_table="gatk2_annotations">
463 <filter type="multiple_splitter" column="tools_valid_for" separator=","/>
464 <filter type="static_value" value="VariantAnnotator" column="tools_valid_for"/>
465 </options>
466 </param>
467
468 </inputs>
469 <outputs>
470 <data format="vcf" name="output_vcf" label="${tool.name} on ${on_string} (Variant File)" />
471 <data format="txt" name="output_log" label="${tool.name} on ${on_string} (log)" />
472 </outputs>
473 <tests>
474 <test>
475 <param name="reference_source_selector" value="history" />
476 <param name="ref_file" value="phiX.fasta" ftype="fasta" />
477 <param name="input_bam" value="gatk/gatk_table_recalibration/gatk_table_recalibration_out_1.bam" ftype="bam" />
478 <param name="input_variant" value="gatk/gatk_unified_genotyper/gatk_unified_genotyper_out_1.vcf" ftype="vcf" />
479 <param name="input_variant_bti" />
480 <param name="annotations_type_selector" value="choose" />
481 <param name="annotations" value="AlleleBalance,BaseQualityRankSumTest,DepthOfCoverage,HomopolymerRun,MappingQualityRankSumTest,MappingQualityZero,QualByDepth,RMSMappingQuality,SpanningDeletions,HaplotypeScore" />
482 <param name="additional_annotations" value="0" />
483 <param name="dbsnp_rod_bind_type_selector" value="set_dbsnp" />
484 <param name="dbsnp_input_rod" value="gatk/fake_phiX_variant_locations.vcf" ftype="vcf" />
485 <param name="snpEff_rod_bind_type_selector" value="exclude_snpEff" />
486 <param name="gatk_param_type_selector" value="basic" />
487 <output name="output_vcf" file="gatk/gatk_variant_annotator/gatk_variant_annotator_out_1.vcf" lines_diff="4" />
488 <output name="output_log" file="gatk/gatk_variant_annotator/gatk_variant_annotator_out_1.log.contains" compare="contains" />
489 <param name="comp_rod_bind" value="0" />
490 <param name="resource_rod_bind" value="0" />
491 <param name="expressions" value="0" />
492 <!-- <param name="annotation_group" /> -->
493 </test>
494 </tests>
495 <help>
496 **What it does**
497
498 Annotates variant calls with context information. Users can specify which of the available annotations to use.
499
500 For more information on using the VariantAnnotator, see this `tool specific page &lt;http://www.broadinstitute.org/gatk/gatkdocs/org_broadinstitute_sting_gatk_walkers_annotator_VariantAnnotator.html&gt;`_.
501
502 To learn about best practices for variant detection using GATK, see this `overview &lt;http://www.broadinstitute.org/gatk/guide/topic?name=best-practices&gt;`_.
503
504 If you encounter errors, please view the `GATK FAQ &lt;http://www.broadinstitute.org/gatk/guide/topic?name=faqs&gt;`_.
505
506 ------
507
508
509 **Inputs**
510
511 GenomeAnalysisTK: VariantAnnotator accepts a variant input file.
512
513
514 **Outputs**
515
516 The output is in VCF format.
517
518
519 Go `here &lt;http://www.broadinstitute.org/gatk/guide/topic?name=intro&gt;`_ for details on GATK file formats.
520
521 -------
522
523 **Settings**::
524
525
526 sampleName The sample (NA-ID) corresponding to the variant input (for non-VCF input only)
527 annotation One or more specific annotations to apply to variant calls
528 group One or more classes/groups of annotations to apply to variant calls
529 expression One or more specific expressions to apply to variant calls; see documentation for more details
530 useAllAnnotations Use all possible annotations (not for the faint of heart)
531
532 ------
533
534 **Citation**
535
536 For the underlying tool, please cite `DePristo MA, Banks E, Poplin R, Garimella KV, Maguire JR, Hartl C, Philippakis AA, del Angel G, Rivas MA, Hanna M, McKenna A, Fennell TJ, Kernytsky AM, Sivachenko AY, Cibulskis K, Gabriel SB, Altshuler D, Daly MJ. A framework for variation discovery and genotyping using next-generation DNA sequencing data. Nat Genet. 2011 May;43(5):491-8. &lt;http://www.ncbi.nlm.nih.gov/pubmed/21478889&gt;`_
537
538 Please also site `McKenna A, Hanna M, Banks E, Sivachenko A, Cibulskis K, Kernytsky A, Garimella K, Altshuler D, Gabriel S, Daly M, DePristo MA (2010). The Genome Analysis Toolkit: a MapReduce framework for analyzing next-generation DNA sequencing data. Genome Res. 20:1297-303. Epub 2010 Jul 19. &lt;http://www.ncbi.nlm.nih.gov/pubmed/20644199&gt;`_
539
540 If you use this tool in Galaxy, please cite `Blankenberg D, Von Kuster G, Coraor N, Ananda G, Lazarus R, Mangan M, Nekrutenko A, Taylor J. Galaxy: a web-based genome analysis tool for experimentalists. Curr Protoc Mol Biol. 2010 Jan;Chapter 19:Unit 19.10.1-21. &lt;http://www.ncbi.nlm.nih.gov/pubmed/20069535&gt;`_
541
542 </help>
543 </tool>