annotate variants_validate.xml @ 0:7e1ecaa64370 draft default tip

Imported from capsule None
author devteam
date Tue, 01 Apr 2014 10:49:56 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
1 <tool id="gatk_validate_variants" name="Validate Variants" version="0.0.4">
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
2 <description></description>
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
3 <requirements>
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
4 <requirement type="package" version="1.4">gatk</requirement>
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
5 </requirements>
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
6 <macros>
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
7 <import>gatk_macros.xml</import>
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
8 </macros>
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
9 <command interpreter="python">gatk_wrapper.py
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
10 --max_jvm_heap_fraction "1"
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
11 --stdout "${output_log}"
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
12 -d "--variant:variant,%(file_type)s" "${reference_source.input_variant}" "${reference_source.input_variant.ext}" "input_variant"
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
13 -p 'java
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
14 -jar "\$JAVA_JAR_PATH/GenomeAnalysisTK.jar"
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
15 -T "ValidateVariants"
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
16
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
17 -et "NO_ET" ##ET no phone home
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
18 ##--num_threads 4 ##hard coded, for now
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
19 ##-log "${output_log}" ##don't use this to log to file, instead directly capture stdout
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
20 #if $reference_source.reference_source_selector != "history":
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
21 -R "${reference_source.ref_file.fields.path}"
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
22 #end if
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
23 ${warn_on_errors}
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
24 ${do_not_validate_filtered_records}
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
25 '
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
26
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
27 #if str( $dbsnp_rod_bind_type.dbsnp_rod_bind_type_selector ) == 'set_dbsnp':
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
28 -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}"
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
29 #end if
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
30
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
31 #include source=$standard_gatk_options#
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
32 </command>
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
33 <inputs>
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
34
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
35 <conditional name="reference_source">
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
36 <expand macro="reference_source_selector_param" />
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
37 <when value="cached">
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
38 <param name="input_variant" type="data" format="vcf" label="Input variant file" help="-V,--variant &amp;lt;variant&amp;gt;" />
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
39 <param name="ref_file" type="select" label="Using reference genome" help="-R,--reference_sequence &amp;lt;reference_sequence&amp;gt;">
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
40 <options from_data_table="gatk_picard_indexes">
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
41 <filter type="data_meta" key="dbkey" ref="input_variant" column="dbkey"/>
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
42 </options>
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
43 <validator type="no_options" message="A built-in reference genome is not available for the build associated with the selected input file"/>
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
44 </param>
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
45 </when>
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
46 <when value="history"> <!-- FIX ME!!!! -->
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
47 <param name="input_variant" type="data" format="vcf" label="Input variant file" help="-V,--variant &amp;lt;variant&amp;gt;" />
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
48 <param name="ref_file" type="data" format="fasta" label="Using reference file" help="-R,--reference_sequence &amp;lt;reference_sequence&amp;gt;" />
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
49 </when>
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
50 </conditional>
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
51
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
52 <conditional name="dbsnp_rod_bind_type">
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
53 <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;">
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
54 <option value="set_dbsnp" selected="True">Set dbSNP</option>
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
55 <option value="exclude_dbsnp">Don't set dbSNP</option>
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
56 </param>
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
57 <when value="exclude_dbsnp">
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
58 <!-- Do nothing here -->
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
59 </when>
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
60 <when value="set_dbsnp">
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
61 <param name="dbsnp_input_rod" type="data" format="vcf" label="ROD file" />
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
62 <param name="dbsnp_rod_name" type="hidden" value="dbsnp" label="ROD Name"/>
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
63 </when>
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
64 </conditional>
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
65
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
66 <param name="warn_on_errors" type="boolean" checked="False" truevalue="-warnOnErrors" falsevalue="" label="instead of terminating the run at the first error, print warning messages for each error seen." help="-warnOnErrors,--warnOnErrors"/>
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
67 <param name="do_not_validate_filtered_records" type="boolean" checked="False" truevalue="-doNotValidateFilteredRecords" falsevalue="" label="do not try to validate records that are FILTERed." help="-doNotValidateFilteredRecords,--doNotValidateFilteredRecords"/>
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
68
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
69 <expand macro="gatk_param_type_conditional" />
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
70
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
71 </inputs>
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
72 <outputs>
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
73 <data format="txt" name="output_log" label="${tool.name} on ${on_string} (log)" />
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
74 </outputs>
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
75 <tests>
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
76 <test>
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
77 <param name="reference_source_selector" value="history" />
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
78 <param name="ref_file" value="phiX.fasta" ftype="fasta" />
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
79 <param name="input_variant" value="gatk/gatk_variant_annotator/gatk_variant_annotator_out_1.vcf" ftype="vcf" />
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
80 <param name="dbsnp_rod_bind_type_selector" value="set_dbsnp" />
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
81 <param name="dbsnp_input_rod" value="gatk/fake_phiX_variant_locations.vcf" ftype="vcf" />
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
82 <param name="warn_on_errors" value="True"/>
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
83 <param name="do_not_validate_filtered_records" />
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
84 <param name="gatk_param_type_selector" value="basic" />
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
85 <output name="output_log" file="gatk/gatk_validate_variants/gatk_validate_variants_out_1.log.contains" compare="contains" />
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
86 </test>
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
87 </tests>
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
88 <help>
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
89 **What it does**
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
90
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
91 Validates a variants file.
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
92
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
93 For more information on using the ValidateVariants module, see this `tool specific page &lt;http://www.broadinstitute.org/gsa/wiki/index.php/VariantValidator&gt;`_.
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
94
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
95 To learn about best practices for variant detection using GATK, see this `overview &lt;http://www.broadinstitute.org/gsa/wiki/index.php/Best_Practice_Variant_Detection_with_the_GATK_v3&gt;`_.
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
96
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
97 If you encounter errors, please view the `GATK FAQ &lt;http://www.broadinstitute.org/gsa/wiki/index.php/Frequently_Asked_Questions&gt;`_.
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
98
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
99 ------
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
100
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
101 **Inputs**
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
102
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
103 GenomeAnalysisTK: ValidateVariants accepts variant files as input.
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
104
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
105
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
106 **Outputs**
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
107
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
108 The output is a log of variant validation.
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
109
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
110
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
111 Go `here &lt;http://www.broadinstitute.org/gsa/wiki/index.php/Input_files_for_the_GATK&gt;`_ for details on GATK file formats.
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
112
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
113 -------
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
114
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
115 **Settings**::
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
116
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
117 doNotValidateFilteredRecords should we skip validation on filtered records?
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
118 warnOnErrors should we just emit warnings on errors instead of terminating the run?
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
119
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
120 @CITATION_SECTION@
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
121 </help>
7e1ecaa64370 Imported from capsule None
devteam
parents:
diff changeset
122 </tool>