annotate variant_eval.xml @ 0:340633249b3d draft

Uploaded
author bgruening
date Mon, 02 Dec 2013 06:18:36 -0500
parents
children 8bcc13094767
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
340633249b3d Uploaded
bgruening
parents:
diff changeset
1 <tool id="gatk2_variant_eval" name="Eval Variants" version="0.0.7">
340633249b3d Uploaded
bgruening
parents:
diff changeset
2 <description></description>
340633249b3d Uploaded
bgruening
parents:
diff changeset
3 <expand macro="requirements" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
4 <macros>
340633249b3d Uploaded
bgruening
parents:
diff changeset
5 <import>gatk2_macros.xml</import>
340633249b3d Uploaded
bgruening
parents:
diff changeset
6 </macros>
340633249b3d Uploaded
bgruening
parents:
diff changeset
7 <command interpreter="python">
340633249b3d Uploaded
bgruening
parents:
diff changeset
8 #from binascii import hexlify
340633249b3d Uploaded
bgruening
parents:
diff changeset
9
340633249b3d Uploaded
bgruening
parents:
diff changeset
10 gatk2_wrapper.py
340633249b3d Uploaded
bgruening
parents:
diff changeset
11 --stdout "${output_log}"
340633249b3d Uploaded
bgruening
parents:
diff changeset
12 #for $var_count, $variant in enumerate( $reference_source.variants ):
340633249b3d Uploaded
bgruening
parents:
diff changeset
13 -d "--eval:input_${var_count},%(file_type)s" "${variant.input_variant}" "${variant.input_variant.ext}" "input_variants_${var_count}"
340633249b3d Uploaded
bgruening
parents:
diff changeset
14 #end for
340633249b3d Uploaded
bgruening
parents:
diff changeset
15 -p '
340633249b3d Uploaded
bgruening
parents:
diff changeset
16 @JAR_PATH@
340633249b3d Uploaded
bgruening
parents:
diff changeset
17 -T "VariantEval"
340633249b3d Uploaded
bgruening
parents:
diff changeset
18 --out "${output_report}"
340633249b3d Uploaded
bgruening
parents:
diff changeset
19 \$GATK2_SITE_OPTIONS
340633249b3d Uploaded
bgruening
parents:
diff changeset
20
340633249b3d Uploaded
bgruening
parents:
diff changeset
21 @THREADS@
340633249b3d Uploaded
bgruening
parents:
diff changeset
22
340633249b3d Uploaded
bgruening
parents:
diff changeset
23 #if $reference_source.reference_source_selector != "history":
340633249b3d Uploaded
bgruening
parents:
diff changeset
24 -R "${reference_source.ref_file.fields.path}"
340633249b3d Uploaded
bgruening
parents:
diff changeset
25 #end if
340633249b3d Uploaded
bgruening
parents:
diff changeset
26 '
340633249b3d Uploaded
bgruening
parents:
diff changeset
27
340633249b3d Uploaded
bgruening
parents:
diff changeset
28 #for $rod_binding in $comp_rod_bind:
340633249b3d Uploaded
bgruening
parents:
diff changeset
29 -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}"
340633249b3d Uploaded
bgruening
parents:
diff changeset
30 #if str( $rod_binding.comp_known_names ):
340633249b3d Uploaded
bgruening
parents:
diff changeset
31 -p '--known_names "${rod_binding.comp_rod_name}"'
340633249b3d Uploaded
bgruening
parents:
diff changeset
32 #end if
340633249b3d Uploaded
bgruening
parents:
diff changeset
33 #end for
340633249b3d Uploaded
bgruening
parents:
diff changeset
34
340633249b3d Uploaded
bgruening
parents:
diff changeset
35 #if str( $dbsnp_rod_bind_type.dbsnp_rod_bind_type_selector ) == 'set_dbsnp':
340633249b3d Uploaded
bgruening
parents:
diff changeset
36 -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}"
340633249b3d Uploaded
bgruening
parents:
diff changeset
37 #if str( $dbsnp_rod_bind_type.dbsnp_known_names ):
340633249b3d Uploaded
bgruening
parents:
diff changeset
38 -p '--known_names "${dbsnp_rod_bind_type.dbsnp_rod_name}"'
340633249b3d Uploaded
bgruening
parents:
diff changeset
39 #end if
340633249b3d Uploaded
bgruening
parents:
diff changeset
40 #end if
340633249b3d Uploaded
bgruening
parents:
diff changeset
41
340633249b3d Uploaded
bgruening
parents:
diff changeset
42 #include source=$standard_gatk_options#
340633249b3d Uploaded
bgruening
parents:
diff changeset
43
340633249b3d Uploaded
bgruening
parents:
diff changeset
44
340633249b3d Uploaded
bgruening
parents:
diff changeset
45 ##start analysis specific options
340633249b3d Uploaded
bgruening
parents:
diff changeset
46 #if $analysis_param_type.analysis_param_type_selector == "advanced":
340633249b3d Uploaded
bgruening
parents:
diff changeset
47 #for $stratification in $analysis_param_type.stratifications:
340633249b3d Uploaded
bgruening
parents:
diff changeset
48 #set $select_string = "--select_exps '%s' --select_names '%s'" % ( str( $stratification.select_exps ), str( $stratification.select_name ) )
340633249b3d Uploaded
bgruening
parents:
diff changeset
49 -o '${ hexlify( $select_string ) }'
340633249b3d Uploaded
bgruening
parents:
diff changeset
50 #end for
340633249b3d Uploaded
bgruening
parents:
diff changeset
51 -p '
340633249b3d Uploaded
bgruening
parents:
diff changeset
52
340633249b3d Uploaded
bgruening
parents:
diff changeset
53 #for $sample in $analysis_param_type.samples:
340633249b3d Uploaded
bgruening
parents:
diff changeset
54 --sample "${sample.sample}"
340633249b3d Uploaded
bgruening
parents:
diff changeset
55 #end for
340633249b3d Uploaded
bgruening
parents:
diff changeset
56
340633249b3d Uploaded
bgruening
parents:
diff changeset
57 #if str( $analysis_param_type.stratification_modules ) != "None":
340633249b3d Uploaded
bgruening
parents:
diff changeset
58 #for $stratification_module in str( $analysis_param_type.stratification_modules).split( ',' ):
340633249b3d Uploaded
bgruening
parents:
diff changeset
59 --stratificationModule "${stratification_module}"
340633249b3d Uploaded
bgruening
parents:
diff changeset
60 #end for
340633249b3d Uploaded
bgruening
parents:
diff changeset
61 #end if
340633249b3d Uploaded
bgruening
parents:
diff changeset
62
340633249b3d Uploaded
bgruening
parents:
diff changeset
63 ${analysis_param_type.do_not_use_all_standard_stratifications}
340633249b3d Uploaded
bgruening
parents:
diff changeset
64
340633249b3d Uploaded
bgruening
parents:
diff changeset
65 #for $variant_type in $analysis_param_type.only_variants_of_type:
340633249b3d Uploaded
bgruening
parents:
diff changeset
66 --onlyVariantsOfType "${variant_type.variant_type}"
340633249b3d Uploaded
bgruening
parents:
diff changeset
67 #end for
340633249b3d Uploaded
bgruening
parents:
diff changeset
68
340633249b3d Uploaded
bgruening
parents:
diff changeset
69 #if str( $analysis_param_type.eval_modules ) != "None":
340633249b3d Uploaded
bgruening
parents:
diff changeset
70 #for $eval_module in str( $analysis_param_type.eval_modules).split( ',' ):
340633249b3d Uploaded
bgruening
parents:
diff changeset
71 --evalModule "${eval_module}"
340633249b3d Uploaded
bgruening
parents:
diff changeset
72 #end for
340633249b3d Uploaded
bgruening
parents:
diff changeset
73 #end if
340633249b3d Uploaded
bgruening
parents:
diff changeset
74
340633249b3d Uploaded
bgruening
parents:
diff changeset
75 ${analysis_param_type.do_not_use_all_standard_modules}
340633249b3d Uploaded
bgruening
parents:
diff changeset
76
340633249b3d Uploaded
bgruening
parents:
diff changeset
77 #if str( $analysis_param_type.num_samples ) != "0":
340633249b3d Uploaded
bgruening
parents:
diff changeset
78 --numSamples "${analysis_param_type.num_samples}"
340633249b3d Uploaded
bgruening
parents:
diff changeset
79 #end if
340633249b3d Uploaded
bgruening
parents:
diff changeset
80
340633249b3d Uploaded
bgruening
parents:
diff changeset
81 --minPhaseQuality "${analysis_param_type.min_phase_quality}"
340633249b3d Uploaded
bgruening
parents:
diff changeset
82
340633249b3d Uploaded
bgruening
parents:
diff changeset
83 #if str( $analysis_param_type.family ):
340633249b3d Uploaded
bgruening
parents:
diff changeset
84 --family_structure "${analysis_param_type.family}"
340633249b3d Uploaded
bgruening
parents:
diff changeset
85 #end if
340633249b3d Uploaded
bgruening
parents:
diff changeset
86
340633249b3d Uploaded
bgruening
parents:
diff changeset
87 --mendelianViolationQualThreshold "${analysis_param_type.mendelian_violation_qual_threshold}"
340633249b3d Uploaded
bgruening
parents:
diff changeset
88
340633249b3d Uploaded
bgruening
parents:
diff changeset
89 #if str( $analysis_param_type.ancestral_alignments ) != "None":
340633249b3d Uploaded
bgruening
parents:
diff changeset
90 --ancestralAlignments "${analysis_param_type.ancestral_alignments}"
340633249b3d Uploaded
bgruening
parents:
diff changeset
91 #end if
340633249b3d Uploaded
bgruening
parents:
diff changeset
92 '
340633249b3d Uploaded
bgruening
parents:
diff changeset
93 #if str( $analysis_param_type.known_cnvs ) != "None":
340633249b3d Uploaded
bgruening
parents:
diff changeset
94 -d "--knownCNVs" "${analysis_param_type.known_cnvs}" "${analysis_param_type.known_cnvs.ext}" "input_known_cnvs"
340633249b3d Uploaded
bgruening
parents:
diff changeset
95 #end if
340633249b3d Uploaded
bgruening
parents:
diff changeset
96
340633249b3d Uploaded
bgruening
parents:
diff changeset
97 #if str( $analysis_param_type.strat_intervals ) != "None":
340633249b3d Uploaded
bgruening
parents:
diff changeset
98 -d "--stratIntervals" "${analysis_param_type.strat_intervals}" "${analysis_param_type.strat_intervals.ext}" "input_strat_intervals"
340633249b3d Uploaded
bgruening
parents:
diff changeset
99 #end if
340633249b3d Uploaded
bgruening
parents:
diff changeset
100 #end if
340633249b3d Uploaded
bgruening
parents:
diff changeset
101 </command>
340633249b3d Uploaded
bgruening
parents:
diff changeset
102 <inputs>
340633249b3d Uploaded
bgruening
parents:
diff changeset
103
340633249b3d Uploaded
bgruening
parents:
diff changeset
104 <conditional name="reference_source">
340633249b3d Uploaded
bgruening
parents:
diff changeset
105 <expand macro="reference_source_selector_param" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
106 <when value="cached">
340633249b3d Uploaded
bgruening
parents:
diff changeset
107 <repeat name="variants" title="Variant" min="1" help="-eval,--eval &amp;lt;eval&amp;gt;">
340633249b3d Uploaded
bgruening
parents:
diff changeset
108 <param name="input_variant" type="data" format="vcf" label="Input variant file" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
109 </repeat>
340633249b3d Uploaded
bgruening
parents:
diff changeset
110 <param name="ref_file" type="select" label="Using reference genome" help="-R,--reference_sequence &amp;lt;reference_sequence&amp;gt;">
340633249b3d Uploaded
bgruening
parents:
diff changeset
111 <options from_data_table="gatk2_picard_indexes">
340633249b3d Uploaded
bgruening
parents:
diff changeset
112 <!-- <filter type="data_meta" key="dbkey" ref="input_variant" column="dbkey"/> -->
340633249b3d Uploaded
bgruening
parents:
diff changeset
113 </options>
340633249b3d Uploaded
bgruening
parents:
diff changeset
114 <validator type="no_options" message="A built-in reference genome is not available for the build associated with the selected input file"/>
340633249b3d Uploaded
bgruening
parents:
diff changeset
115 </param>
340633249b3d Uploaded
bgruening
parents:
diff changeset
116 </when>
340633249b3d Uploaded
bgruening
parents:
diff changeset
117 <when value="history"> <!-- FIX ME!!!! -->
340633249b3d Uploaded
bgruening
parents:
diff changeset
118 <repeat name="variants" title="Variant" min="1" help="-eval,--eval &amp;lt;eval&amp;gt;">
340633249b3d Uploaded
bgruening
parents:
diff changeset
119 <param name="input_variant" type="data" format="vcf" label="Input variant file" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
120 </repeat>
340633249b3d Uploaded
bgruening
parents:
diff changeset
121 <param name="ref_file" type="data" format="fasta" label="Using reference file" help="-R,--reference_sequence &amp;lt;reference_sequence&amp;gt;" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
122 </when>
340633249b3d Uploaded
bgruening
parents:
diff changeset
123 </conditional>
340633249b3d Uploaded
bgruening
parents:
diff changeset
124
340633249b3d Uploaded
bgruening
parents:
diff changeset
125 <repeat name="comp_rod_bind" title="Binding for reference-ordered comparison data" help="-comp,--comp &amp;lt;comp&amp;gt;">
340633249b3d Uploaded
bgruening
parents:
diff changeset
126 <param name="comp_input_rod" type="data" format="vcf" label="Comparison ROD file" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
127 <param name="comp_rod_name" type="text" value="Unnamed" label="Comparison ROD Name"/>
340633249b3d Uploaded
bgruening
parents:
diff changeset
128 <param name="comp_known_names" type="boolean" truevalue="--known_names" falsevalue="" label="Use Comparison ROD as known_names" help="-knownName,--known_names &amp;lt;known_names&amp;gt;"/>
340633249b3d Uploaded
bgruening
parents:
diff changeset
129 </repeat>
340633249b3d Uploaded
bgruening
parents:
diff changeset
130
340633249b3d Uploaded
bgruening
parents:
diff changeset
131 <conditional name="dbsnp_rod_bind_type">
340633249b3d Uploaded
bgruening
parents:
diff changeset
132 <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;">
340633249b3d Uploaded
bgruening
parents:
diff changeset
133 <option value="set_dbsnp" selected="True">Set dbSNP</option>
340633249b3d Uploaded
bgruening
parents:
diff changeset
134 <option value="exclude_dbsnp">Don't set dbSNP</option>
340633249b3d Uploaded
bgruening
parents:
diff changeset
135 </param>
340633249b3d Uploaded
bgruening
parents:
diff changeset
136 <when value="exclude_dbsnp">
340633249b3d Uploaded
bgruening
parents:
diff changeset
137 <!-- Do nothing here -->
340633249b3d Uploaded
bgruening
parents:
diff changeset
138 </when>
340633249b3d Uploaded
bgruening
parents:
diff changeset
139 <when value="set_dbsnp">
340633249b3d Uploaded
bgruening
parents:
diff changeset
140 <param name="dbsnp_input_rod" type="data" format="vcf" label="dbSNP ROD file" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
141 <param name="dbsnp_rod_name" type="hidden" value="dbsnp" label="dbSNP ROD Name"/>
340633249b3d Uploaded
bgruening
parents:
diff changeset
142 <param name="dbsnp_known_names" type="boolean" truevalue="--known_names" falsevalue="" label="Use dbSNP ROD as known_names" help="-knownName,--known_names &amp;lt;known_names&amp;gt;" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
143 </when>
340633249b3d Uploaded
bgruening
parents:
diff changeset
144 </conditional>
340633249b3d Uploaded
bgruening
parents:
diff changeset
145
340633249b3d Uploaded
bgruening
parents:
diff changeset
146 <expand macro="gatk_param_type_conditional" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
147
340633249b3d Uploaded
bgruening
parents:
diff changeset
148
340633249b3d Uploaded
bgruening
parents:
diff changeset
149 <expand macro="analysis_type_conditional">
340633249b3d Uploaded
bgruening
parents:
diff changeset
150 <repeat name="stratifications" title="Stratification">
340633249b3d Uploaded
bgruening
parents:
diff changeset
151 <param name="select_exps" value="" type="text" label="Stratification Expression" help="-select,--select_exps &amp;lt;select_exps&amp;gt;">
340633249b3d Uploaded
bgruening
parents:
diff changeset
152 <sanitizer>
340633249b3d Uploaded
bgruening
parents:
diff changeset
153 <valid initial="string.printable">
340633249b3d Uploaded
bgruening
parents:
diff changeset
154 <remove value="&apos;"/>
340633249b3d Uploaded
bgruening
parents:
diff changeset
155 </valid>
340633249b3d Uploaded
bgruening
parents:
diff changeset
156 <mapping initial="none"/>
340633249b3d Uploaded
bgruening
parents:
diff changeset
157 </sanitizer>
340633249b3d Uploaded
bgruening
parents:
diff changeset
158 </param>
340633249b3d Uploaded
bgruening
parents:
diff changeset
159 <param name="select_name" value="" type="text" label="Name" help="-selectName,--select_names &amp;lt;select_names&amp;gt;"/>
340633249b3d Uploaded
bgruening
parents:
diff changeset
160 </repeat>
340633249b3d Uploaded
bgruening
parents:
diff changeset
161
340633249b3d Uploaded
bgruening
parents:
diff changeset
162 <repeat name="samples" title="Sample" help="-sn,--sample &amp;lt;sample&amp;gt;">
340633249b3d Uploaded
bgruening
parents:
diff changeset
163 <param name="sample" value="" type="text" label="Derive eval and comp contexts using only these sample genotypes, when genotypes are available in the original context"/>
340633249b3d Uploaded
bgruening
parents:
diff changeset
164 </repeat>
340633249b3d Uploaded
bgruening
parents:
diff changeset
165
340633249b3d Uploaded
bgruening
parents:
diff changeset
166 <param name="stratification_modules" type="select" multiple="True" display="checkboxes" label="Stratification modules to apply to the eval track(s)" help="-ST,--stratificationModule &amp;lt;stratificationModule&amp;gt;" >
340633249b3d Uploaded
bgruening
parents:
diff changeset
167 <!-- do these need individual options also? gatk wiki has little info -->
340633249b3d Uploaded
bgruening
parents:
diff changeset
168 <option value="AlleleFrequency" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
169 <option value="AlleleCount" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
170 <option value="CompRod" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
171 <option value="Contig" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
172 <option value="CpG" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
173 <option value="Degeneracy" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
174 <option value="EvalRod" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
175 <option value="Filter" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
176 <option value="FunctionalClass" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
177 <option value="JexlExpression" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
178 <option value="Sample" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
179 <option value="IntervalStratification" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
180 </param>
340633249b3d Uploaded
bgruening
parents:
diff changeset
181 <param name="do_not_use_all_standard_stratifications" checked="false" type="boolean" truevalue="--doNotUseAllStandardStratifications" falsevalue="" label="Do not use the standard stratification modules by default" help="-noST,--doNotUseAllStandardStratifications" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
182
340633249b3d Uploaded
bgruening
parents:
diff changeset
183 <repeat name="only_variants_of_type" title="only Variants Of Type" help="--onlyVariantsOfType">
340633249b3d Uploaded
bgruening
parents:
diff changeset
184 <param name="variant_type" type="text" value="" label="only variants of these types will be considered during the evaluation"/>
340633249b3d Uploaded
bgruening
parents:
diff changeset
185 </repeat>
340633249b3d Uploaded
bgruening
parents:
diff changeset
186
340633249b3d Uploaded
bgruening
parents:
diff changeset
187 <param name="eval_modules" type="select" multiple="True" display="checkboxes" label="Eval modules to apply to the eval track(s)" help="-EV,--evalModule &amp;lt;evalModule&amp;gt;" >
340633249b3d Uploaded
bgruening
parents:
diff changeset
188 <!-- do these need individual options also? gatk wiki has little info -->
340633249b3d Uploaded
bgruening
parents:
diff changeset
189 <option value="ACTransitionTable" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
190 <option value="AlleleFrequencyComparison" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
191 <option value="AminoAcidTransition" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
192 <option value="CompOverlap" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
193 <option value="CountVariants" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
194 <option value="GenotypeConcordance" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
195 <option value="GenotypePhasingEvaluator" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
196 <option value="IndelMetricsByAC" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
197 <option value="IndelStatistics" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
198 <option value="MendelianViolationEvaluator" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
199 <option value="PrintMissingComp" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
200 <option value="PrivatePermutations" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
201 <option value="SimpleMetricsByAC" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
202 <option value="ThetaVariantEvaluator" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
203 <option value="TiTvVariantEvaluator" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
204 <option value="VariantQualityScore" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
205 </param>
340633249b3d Uploaded
bgruening
parents:
diff changeset
206 <param name="do_not_use_all_standard_modules" checked="false" type="boolean" truevalue="--doNotUseAllStandardModules" falsevalue="" label="Do not use the standard eval modules by default" help="-noEV,--doNotUseAllStandardModules" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
207
340633249b3d Uploaded
bgruening
parents:
diff changeset
208 <param name="num_samples" type="integer" label="Number of samples (used if no samples are available in the VCF file" value="0" help="-ns,--numSamples &amp;lt;numSamples&amp;gt;"/>
340633249b3d Uploaded
bgruening
parents:
diff changeset
209 <param name="min_phase_quality" type="float" label="Minimum phasing quality " value="10.0" help="-mpq,--minPhaseQuality &amp;lt;minPhaseQuality&amp;gt;"/>
340633249b3d Uploaded
bgruening
parents:
diff changeset
210 <param name="family" type="text" value="" label="If provided, genotypes in will be examined for mendelian violations: this argument is a string formatted as dad+mom=child where these parameters determine which sample names are examined" help="--family_structure"/>
340633249b3d Uploaded
bgruening
parents:
diff changeset
211 <param name="mendelian_violation_qual_threshold" type="integer" label="Minimum genotype QUAL score for each trio member required to accept a site as a violation" value="50" help="-mvq,--mendelianViolationQualThreshold &amp;lt;mendelianViolationQualThreshold&amp;gt;"/>
340633249b3d Uploaded
bgruening
parents:
diff changeset
212 <param name="ancestral_alignments" type="data" format="fasta" optional="True" label="Fasta file with ancestral alleles" help="-aa,--ancestralAlignments &amp;lt;ancestralAlignments&amp;gt;" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
213 <param name="known_cnvs" type="data" format="bed,gatk_interval,picard_interval_list" optional="True" label="File containing tribble-readable features describing a known list of copy number variants" help="-knownCNVs,--knownCNVs &amp;lt;knownCNVs&amp;gt;" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
214 <param name="strat_intervals" type="data" format="bed,gatk_interval,picard_interval_list" optional="True" label="File containing tribble-readable features for the IntervalStratificiation" help="-stratIntervals,--stratIntervals &amp;lt;stratIntervals&amp;gt;" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
215
340633249b3d Uploaded
bgruening
parents:
diff changeset
216 </expand>
340633249b3d Uploaded
bgruening
parents:
diff changeset
217
340633249b3d Uploaded
bgruening
parents:
diff changeset
218
340633249b3d Uploaded
bgruening
parents:
diff changeset
219 </inputs>
340633249b3d Uploaded
bgruening
parents:
diff changeset
220 <outputs>
340633249b3d Uploaded
bgruening
parents:
diff changeset
221 <data format="gatk_report" name="output_report" label="${tool.name} on ${on_string} (report)" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
222 <data format="txt" name="output_log" label="${tool.name} on ${on_string} (log)" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
223 </outputs>
340633249b3d Uploaded
bgruening
parents:
diff changeset
224 <tests>
340633249b3d Uploaded
bgruening
parents:
diff changeset
225 <test>
340633249b3d Uploaded
bgruening
parents:
diff changeset
226 <param name="reference_source_selector" value="history" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
227 <param name="ref_file" value="phiX.fasta" ftype="fasta" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
228 <param name="input_variant" value="gatk/gatk_variant_annotator/gatk_variant_annotator_out_1.vcf" ftype="vcf" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
229 <param name="dbsnp_rod_bind_type_selector" value="set_dbsnp" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
230 <param name="dbsnp_input_rod" value="gatk/fake_phiX_variant_locations.vcf" ftype="vcf" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
231 <param name="dbsnp_known_names" value="True"/>
340633249b3d Uploaded
bgruening
parents:
diff changeset
232 <param name="comp_rod_bind" value="0" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
233 <param name="gatk_param_type_selector" value="basic" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
234 <param name="analysis_param_type_selector" value="basic" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
235 <output name="output_report" file="gatk/gatk_variant_eval/gatk_variant_eval_out_1.gatk_report" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
236 <output name="output_log" file="gatk/gatk_variant_eval/gatk_variant_eval_out_1.log.contains" compare="contains" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
237 </test>
340633249b3d Uploaded
bgruening
parents:
diff changeset
238 </tests>
340633249b3d Uploaded
bgruening
parents:
diff changeset
239 <help>
340633249b3d Uploaded
bgruening
parents:
diff changeset
240 **What it does**
340633249b3d Uploaded
bgruening
parents:
diff changeset
241
340633249b3d Uploaded
bgruening
parents:
diff changeset
242 General-purpose tool for variant evaluation (% in dbSNP, genotype concordance, Ti/Tv ratios, and a lot more)
340633249b3d Uploaded
bgruening
parents:
diff changeset
243
340633249b3d Uploaded
bgruening
parents:
diff changeset
244 For more information on using the VariantEval module, see this `tool specific page &lt;http://www.broadinstitute.org/gatk/gatkdocs/org_broadinstitute_sting_gatk_walkers_varianteval_VariantEval.html&gt;`_.
340633249b3d Uploaded
bgruening
parents:
diff changeset
245
340633249b3d Uploaded
bgruening
parents:
diff changeset
246 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;`_.
340633249b3d Uploaded
bgruening
parents:
diff changeset
247
340633249b3d Uploaded
bgruening
parents:
diff changeset
248 If you encounter errors, please view the `GATK FAQ &lt;http://www.broadinstitute.org/gatk/guide/topic?name=faqs&gt;`_.
340633249b3d Uploaded
bgruening
parents:
diff changeset
249
340633249b3d Uploaded
bgruening
parents:
diff changeset
250 ------
340633249b3d Uploaded
bgruening
parents:
diff changeset
251
340633249b3d Uploaded
bgruening
parents:
diff changeset
252 **Inputs**
340633249b3d Uploaded
bgruening
parents:
diff changeset
253
340633249b3d Uploaded
bgruening
parents:
diff changeset
254 GenomeAnalysisTK: VariantEval accepts variant files as input.
340633249b3d Uploaded
bgruening
parents:
diff changeset
255
340633249b3d Uploaded
bgruening
parents:
diff changeset
256
340633249b3d Uploaded
bgruening
parents:
diff changeset
257 **Outputs**
340633249b3d Uploaded
bgruening
parents:
diff changeset
258
340633249b3d Uploaded
bgruening
parents:
diff changeset
259 The output is a table of variant evaluation.
340633249b3d Uploaded
bgruening
parents:
diff changeset
260
340633249b3d Uploaded
bgruening
parents:
diff changeset
261
340633249b3d Uploaded
bgruening
parents:
diff changeset
262 Go `here &lt;http://www.broadinstitute.org/gatk/guide/topic?name=intro&gt;`_ for details on GATK file formats.
340633249b3d Uploaded
bgruening
parents:
diff changeset
263
340633249b3d Uploaded
bgruening
parents:
diff changeset
264 -------
340633249b3d Uploaded
bgruening
parents:
diff changeset
265
340633249b3d Uploaded
bgruening
parents:
diff changeset
266 **Settings**::
340633249b3d Uploaded
bgruening
parents:
diff changeset
267
340633249b3d Uploaded
bgruening
parents:
diff changeset
268 out An output file presented to the walker. Will overwrite contents if file exists.
340633249b3d Uploaded
bgruening
parents:
diff changeset
269 list List the available eval modules and exit
340633249b3d Uploaded
bgruening
parents:
diff changeset
270 select_exps One or more stratifications to use when evaluating the data
340633249b3d Uploaded
bgruening
parents:
diff changeset
271 select_names Names to use for the list of stratifications (must be a 1-to-1 mapping)
340633249b3d Uploaded
bgruening
parents:
diff changeset
272 sample Derive eval and comp contexts using only these sample genotypes, when genotypes are available in the original context
340633249b3d Uploaded
bgruening
parents:
diff changeset
273 known_names Name of ROD bindings containing variant sites that should be treated as known when splitting eval rods into known and novel subsets
340633249b3d Uploaded
bgruening
parents:
diff changeset
274 stratificationModule One or more specific stratification modules to apply to the eval track(s) (in addition to the standard stratifications, unless -noS is specified)
340633249b3d Uploaded
bgruening
parents:
diff changeset
275 doNotUseAllStandardStratifications Do not use the standard stratification modules by default (instead, only those that are specified with the -S option)
340633249b3d Uploaded
bgruening
parents:
diff changeset
276 onlyVariantsOfType If provided, only variants of these types will be considered during the evaluation, in
340633249b3d Uploaded
bgruening
parents:
diff changeset
277 evalModule One or more specific eval modules to apply to the eval track(s) (in addition to the standard modules, unless -noE is specified)
340633249b3d Uploaded
bgruening
parents:
diff changeset
278 doNotUseAllStandardModules Do not use the standard modules by default (instead, only those that are specified with the -E option)
340633249b3d Uploaded
bgruening
parents:
diff changeset
279 numSamples Number of samples (used if no samples are available in the VCF file
340633249b3d Uploaded
bgruening
parents:
diff changeset
280 minPhaseQuality Minimum phasing quality
340633249b3d Uploaded
bgruening
parents:
diff changeset
281 family_structure If provided, genotypes in will be examined for mendelian violations: this argument is a string formatted as dad+mom=child where these parameters determine which sample names are examined
340633249b3d Uploaded
bgruening
parents:
diff changeset
282 mendelianViolationQualThreshold Minimum genotype QUAL score for each trio member required to accept a site as a violation
340633249b3d Uploaded
bgruening
parents:
diff changeset
283 ancestralAlignments Fasta file with ancestral alleles
340633249b3d Uploaded
bgruening
parents:
diff changeset
284
340633249b3d Uploaded
bgruening
parents:
diff changeset
285 @CITATION_SECTION@
340633249b3d Uploaded
bgruening
parents:
diff changeset
286 </help>
340633249b3d Uploaded
bgruening
parents:
diff changeset
287 </tool>