annotate variant_select.xml @ 5:84584664264c draft

Uploaded
author iuc
date Mon, 25 Aug 2014 17:44:53 -0400
parents f244b8209eb8
children 35c00763cb5c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4
f244b8209eb8 bug fix release
iuc
parents: 0
diff changeset
1 <tool id="gatk2_variant_select" name="Select Variants" version="@VERSION@.0">
0
340633249b3d Uploaded
bgruening
parents:
diff changeset
2 <description>from VCF files</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 -d "--variant:variant,%(file_type)s" "${reference_source.input_variant}" "${reference_source.input_variant.ext}" "input_variant"
340633249b3d Uploaded
bgruening
parents:
diff changeset
13 -p '
340633249b3d Uploaded
bgruening
parents:
diff changeset
14 @JAR_PATH@
340633249b3d Uploaded
bgruening
parents:
diff changeset
15 -T "SelectVariants"
340633249b3d Uploaded
bgruening
parents:
diff changeset
16 \$GATK2_SITE_OPTIONS
340633249b3d Uploaded
bgruening
parents:
diff changeset
17
340633249b3d Uploaded
bgruening
parents:
diff changeset
18 @THREADS@
340633249b3d Uploaded
bgruening
parents:
diff changeset
19 -o "${output_vcf}"
340633249b3d Uploaded
bgruening
parents:
diff changeset
20
340633249b3d Uploaded
bgruening
parents:
diff changeset
21 #if $reference_source.reference_source_selector != "history":
340633249b3d Uploaded
bgruening
parents:
diff changeset
22 -R "${reference_source.ref_file.fields.path}"
340633249b3d Uploaded
bgruening
parents:
diff changeset
23 #end if
340633249b3d Uploaded
bgruening
parents:
diff changeset
24 '
340633249b3d Uploaded
bgruening
parents:
diff changeset
25 -p '
340633249b3d Uploaded
bgruening
parents:
diff changeset
26 #if $input_concordance:
340633249b3d Uploaded
bgruening
parents:
diff changeset
27 --concordance "${input_concordance}"
340633249b3d Uploaded
bgruening
parents:
diff changeset
28 #end if
340633249b3d Uploaded
bgruening
parents:
diff changeset
29 #if $input_discordance:
340633249b3d Uploaded
bgruening
parents:
diff changeset
30 --discordance "${input_discordance}"
340633249b3d Uploaded
bgruening
parents:
diff changeset
31 #end if
340633249b3d Uploaded
bgruening
parents:
diff changeset
32
340633249b3d Uploaded
bgruening
parents:
diff changeset
33 #for $exclude_sample_name in $exclude_sample_name_repeat:
340633249b3d Uploaded
bgruening
parents:
diff changeset
34 --exclude_sample_name "${exclude_sample_name.exclude_sample_name}"
340633249b3d Uploaded
bgruening
parents:
diff changeset
35 #end for
340633249b3d Uploaded
bgruening
parents:
diff changeset
36
340633249b3d Uploaded
bgruening
parents:
diff changeset
37 ${exclude_filtered}
340633249b3d Uploaded
bgruening
parents:
diff changeset
38
340633249b3d Uploaded
bgruening
parents:
diff changeset
39 #for $sample_name in $sample_name_repeat:
340633249b3d Uploaded
bgruening
parents:
diff changeset
40 --sample_name "${sample_name.sample_name}"
340633249b3d Uploaded
bgruening
parents:
diff changeset
41 #end for
340633249b3d Uploaded
bgruening
parents:
diff changeset
42 '
340633249b3d Uploaded
bgruening
parents:
diff changeset
43
340633249b3d Uploaded
bgruening
parents:
diff changeset
44 #for $select_expressions in $select_expressions_repeat:
340633249b3d Uploaded
bgruening
parents:
diff changeset
45 #set $select_expression = "--select_expressions '%s'" % ( str( $select_expressions.select_expressions ) )
340633249b3d Uploaded
bgruening
parents:
diff changeset
46 -o '${ hexlify( $select_expression ) }'
340633249b3d Uploaded
bgruening
parents:
diff changeset
47 #end for
340633249b3d Uploaded
bgruening
parents:
diff changeset
48
340633249b3d Uploaded
bgruening
parents:
diff changeset
49 ##start tool specific options
340633249b3d Uploaded
bgruening
parents:
diff changeset
50 #if str( $analysis_param_type.analysis_param_type_selector ) == 'advanced':
340633249b3d Uploaded
bgruening
parents:
diff changeset
51 -p '
340633249b3d Uploaded
bgruening
parents:
diff changeset
52 #for $exclude_sample_file in $analysis_param_type.exclude_sample_file_repeat:
340633249b3d Uploaded
bgruening
parents:
diff changeset
53 --exclude_sample_file "${exclude_sample_file.exclude_sample_file}"
340633249b3d Uploaded
bgruening
parents:
diff changeset
54 #end for
340633249b3d Uploaded
bgruening
parents:
diff changeset
55
340633249b3d Uploaded
bgruening
parents:
diff changeset
56 #for $sample_file in $analysis_param_type.sample_file_repeat:
340633249b3d Uploaded
bgruening
parents:
diff changeset
57 --sample_file "${ample_file.sample_file}"
340633249b3d Uploaded
bgruening
parents:
diff changeset
58 #end for
340633249b3d Uploaded
bgruening
parents:
diff changeset
59
340633249b3d Uploaded
bgruening
parents:
diff changeset
60 #if $analysis_param_type.input_keep_ids:
340633249b3d Uploaded
bgruening
parents:
diff changeset
61 --keepIDs "${analysis_param_type.input_keep_ids}"
340633249b3d Uploaded
bgruening
parents:
diff changeset
62 #end if
340633249b3d Uploaded
bgruening
parents:
diff changeset
63
340633249b3d Uploaded
bgruening
parents:
diff changeset
64 ${analysis_param_type.keep_original_AC}
340633249b3d Uploaded
bgruening
parents:
diff changeset
65
340633249b3d Uploaded
bgruening
parents:
diff changeset
66 ${analysis_param_type.mendelian_violation}
340633249b3d Uploaded
bgruening
parents:
diff changeset
67
340633249b3d Uploaded
bgruening
parents:
diff changeset
68 --mendelianViolationQualThreshold "${analysis_param_type.mendelian_violation_qual_threshold}"
340633249b3d Uploaded
bgruening
parents:
diff changeset
69
340633249b3d Uploaded
bgruening
parents:
diff changeset
70 --remove_fraction_genotypes "${analysis_param_type.remove_fraction_genotypes}"
340633249b3d Uploaded
bgruening
parents:
diff changeset
71
340633249b3d Uploaded
bgruening
parents:
diff changeset
72 --restrictAllelesTo "${analysis_param_type.restrict_alleles_to}"
340633249b3d Uploaded
bgruening
parents:
diff changeset
73
340633249b3d Uploaded
bgruening
parents:
diff changeset
74 #if str( $analysis_param_type.select_random_type.select_random_type_selector ) == 'select_random_fraction':
340633249b3d Uploaded
bgruening
parents:
diff changeset
75 --select_random_fraction "${analysis_param_type.select_random_type.select_random_fraction}"
340633249b3d Uploaded
bgruening
parents:
diff changeset
76 #elif str( $analysis_param_type.select_random_type.select_random_type_selector ) == 'select_random_number':
340633249b3d Uploaded
bgruening
parents:
diff changeset
77 --select_random_number "${analysis_param_type.select_random_type.select_random_number}"
340633249b3d Uploaded
bgruening
parents:
diff changeset
78 #end if
340633249b3d Uploaded
bgruening
parents:
diff changeset
79
340633249b3d Uploaded
bgruening
parents:
diff changeset
80 #if $analysis_param_type.select_type_to_include:
340633249b3d Uploaded
bgruening
parents:
diff changeset
81 #for $type_to_include in str( $analysis_param_type.select_type_to_include ).split( ',' ):
340633249b3d Uploaded
bgruening
parents:
diff changeset
82 --selectTypeToInclude "${type_to_include}"
340633249b3d Uploaded
bgruening
parents:
diff changeset
83 #end for
340633249b3d Uploaded
bgruening
parents:
diff changeset
84 #end if
340633249b3d Uploaded
bgruening
parents:
diff changeset
85
340633249b3d Uploaded
bgruening
parents:
diff changeset
86 ${analysis_param_type.exclude_non_variants}
340633249b3d Uploaded
bgruening
parents:
diff changeset
87 '
340633249b3d Uploaded
bgruening
parents:
diff changeset
88
340633249b3d Uploaded
bgruening
parents:
diff changeset
89 #for $sample_expressions in $analysis_param_type.sample_expressions_repeat:
340633249b3d Uploaded
bgruening
parents:
diff changeset
90 #set $sample_expression = "--sample_expressions '%s'" % ( str( $sample_expressions.sample_expressions ) )
340633249b3d Uploaded
bgruening
parents:
diff changeset
91 -o '${ hexlify( $sample_expression ) }'
340633249b3d Uploaded
bgruening
parents:
diff changeset
92 #end for
340633249b3d Uploaded
bgruening
parents:
diff changeset
93
340633249b3d Uploaded
bgruening
parents:
diff changeset
94 #end if
340633249b3d Uploaded
bgruening
parents:
diff changeset
95 ##end tool specific options
340633249b3d Uploaded
bgruening
parents:
diff changeset
96
340633249b3d Uploaded
bgruening
parents:
diff changeset
97 #include source=$standard_gatk_options#
340633249b3d Uploaded
bgruening
parents:
diff changeset
98
340633249b3d Uploaded
bgruening
parents:
diff changeset
99
340633249b3d Uploaded
bgruening
parents:
diff changeset
100 </command>
340633249b3d Uploaded
bgruening
parents:
diff changeset
101 <inputs>
340633249b3d Uploaded
bgruening
parents:
diff changeset
102 <conditional name="reference_source">
340633249b3d Uploaded
bgruening
parents:
diff changeset
103 <expand macro="reference_source_selector_param" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
104 <when value="cached">
340633249b3d Uploaded
bgruening
parents:
diff changeset
105 <param name="input_variant" type="data" format="vcf" label="Variant file to select" help="-V,--variant &amp;lt;variant&amp;gt;" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
106 <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
107 <options from_data_table="gatk2_picard_indexes">
340633249b3d Uploaded
bgruening
parents:
diff changeset
108 <filter type="data_meta" key="dbkey" ref="input_variant" column="dbkey"/>
340633249b3d Uploaded
bgruening
parents:
diff changeset
109 </options>
340633249b3d Uploaded
bgruening
parents:
diff changeset
110 <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
111 </param>
340633249b3d Uploaded
bgruening
parents:
diff changeset
112 </when>
340633249b3d Uploaded
bgruening
parents:
diff changeset
113 <when value="history"> <!-- FIX ME!!!! -->
340633249b3d Uploaded
bgruening
parents:
diff changeset
114 <param name="input_variant" type="data" format="vcf" label="Variant file to select" help="-V,--variant &amp;lt;variant&amp;gt;" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
115 <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
116 </when>
340633249b3d Uploaded
bgruening
parents:
diff changeset
117 </conditional>
340633249b3d Uploaded
bgruening
parents:
diff changeset
118
340633249b3d Uploaded
bgruening
parents:
diff changeset
119 <repeat name="select_expressions_repeat" title="Criteria to use when selecting the data" help="-select,--select_expressions &amp;lt;select_expressions&amp;gt;">
340633249b3d Uploaded
bgruening
parents:
diff changeset
120 <param name="select_expressions" type="text" label="JEXL expression">
340633249b3d Uploaded
bgruening
parents:
diff changeset
121 <sanitizer>
340633249b3d Uploaded
bgruening
parents:
diff changeset
122 <valid initial="string.printable">
340633249b3d Uploaded
bgruening
parents:
diff changeset
123 <remove value="&apos;"/>
340633249b3d Uploaded
bgruening
parents:
diff changeset
124 </valid>
340633249b3d Uploaded
bgruening
parents:
diff changeset
125 <mapping initial="none"/>
340633249b3d Uploaded
bgruening
parents:
diff changeset
126 </sanitizer>
340633249b3d Uploaded
bgruening
parents:
diff changeset
127 </param>
340633249b3d Uploaded
bgruening
parents:
diff changeset
128 </repeat>
340633249b3d Uploaded
bgruening
parents:
diff changeset
129
340633249b3d Uploaded
bgruening
parents:
diff changeset
130 <param name="input_concordance" type="data" format="vcf" label="Output variants that were also called in this comparison track" optional="True" help="-conc,--concordance &amp;lt;concordance&amp;gt;"/>
340633249b3d Uploaded
bgruening
parents:
diff changeset
131 <param name="input_discordance" type="data" format="vcf" label="Output variants that were not called in this comparison track" optional="True" help="-disc,--discordance &amp;lt;discordance&amp;gt;"/>
340633249b3d Uploaded
bgruening
parents:
diff changeset
132
340633249b3d Uploaded
bgruening
parents:
diff changeset
133 <repeat name="sample_name_repeat" title="Include Samples by name" help="-sn,--sample_name &amp;lt;sample_name&amp;gt;">
340633249b3d Uploaded
bgruening
parents:
diff changeset
134 <param name="sample_name" type="text" label="Include genotypes from this sample"/>
340633249b3d Uploaded
bgruening
parents:
diff changeset
135 </repeat>
340633249b3d Uploaded
bgruening
parents:
diff changeset
136
340633249b3d Uploaded
bgruening
parents:
diff changeset
137 <repeat name="exclude_sample_name_repeat" title="Exclude Samples by name" help="-xl_sn,--exclude_sample_name &amp;lt;exclude_sample_name&amp;gt;">
340633249b3d Uploaded
bgruening
parents:
diff changeset
138 <param name="exclude_sample_name" type="text" label="Exclude genotypes from this sample"/>
340633249b3d Uploaded
bgruening
parents:
diff changeset
139 </repeat>
340633249b3d Uploaded
bgruening
parents:
diff changeset
140
340633249b3d Uploaded
bgruening
parents:
diff changeset
141 <param name="exclude_filtered" type="boolean" truevalue="--excludeFiltered" falsevalue="" label="Don't include filtered loci in the analysis" help="-ef,--excludeFiltered" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
142
340633249b3d Uploaded
bgruening
parents:
diff changeset
143 <expand macro="gatk_param_type_conditional" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
144
340633249b3d Uploaded
bgruening
parents:
diff changeset
145
340633249b3d Uploaded
bgruening
parents:
diff changeset
146 <expand macro="analysis_type_conditional">
340633249b3d Uploaded
bgruening
parents:
diff changeset
147
340633249b3d Uploaded
bgruening
parents:
diff changeset
148 <repeat name="exclude_sample_file_repeat" title="Exclude Samples by file" help="-xl_sf,--exclude_sample_file &amp;lt;exclude_sample_file&amp;gt;">
340633249b3d Uploaded
bgruening
parents:
diff changeset
149 <param name="exclude_sample_file" type="data" format="txt" label="File containing a list of samples (one per line) to exclude"/>
340633249b3d Uploaded
bgruening
parents:
diff changeset
150 </repeat>
340633249b3d Uploaded
bgruening
parents:
diff changeset
151
340633249b3d Uploaded
bgruening
parents:
diff changeset
152 <repeat name="sample_file_repeat" title="Samples by file" help="-sf,--sample_file &amp;lt;sample_file&amp;gt;">
340633249b3d Uploaded
bgruening
parents:
diff changeset
153 <param name="sample_file" type="data" format="txt" label="File containing a list of samples (one per line) to include" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
154 </repeat>
340633249b3d Uploaded
bgruening
parents:
diff changeset
155
340633249b3d Uploaded
bgruening
parents:
diff changeset
156 <param name="input_keep_ids" type="data" format="text" label="Only emit sites whose ID is found in this file" optional="True" help="-IDs,--keepIDs &amp;lt;keepIDs&amp;gt;"/>
340633249b3d Uploaded
bgruening
parents:
diff changeset
157
340633249b3d Uploaded
bgruening
parents:
diff changeset
158 <param name="keep_original_AC" type="boolean" truevalue="--keepOriginalAC" falsevalue="" label="Don't update the AC, AF, or AN values in the INFO field after selecting" help="-keepOriginalAC,--keepOriginalAC" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
159
340633249b3d Uploaded
bgruening
parents:
diff changeset
160 <param name="mendelian_violation" type="boolean" truevalue="--mendelianViolation" falsevalue="" label="output mendelian violation sites only" help="-mv,--mendelianViolation" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
161
340633249b3d Uploaded
bgruening
parents:
diff changeset
162 <param name="mendelian_violation_qual_threshold" type="float" label="Minimum genotype QUAL score for each trio member required to accept a site as a mendelian violation" value="0" help="-mvq,--mendelianViolationQualThreshold &amp;lt;mendelianViolationQualThreshold&amp;gt;" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
163
340633249b3d Uploaded
bgruening
parents:
diff changeset
164 <param name="remove_fraction_genotypes" type="float" label="Selects a fraction (a number between 0 and 1) of the total genotypes at random from the variant track and sets them to nocall" value="0" min="0" max="1" help="-fractionGenotypes,--remove_fraction_genotypes &amp;lt;remove_fraction_genotypes&amp;gt;" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
165
340633249b3d Uploaded
bgruening
parents:
diff changeset
166 <param name="restrict_alleles_to" type="select" label="Select only variants of a particular allelicity" help="-restrictAllelesTo,--restrictAllelesTo &amp;lt;restrictAllelesTo&amp;gt;">
340633249b3d Uploaded
bgruening
parents:
diff changeset
167 <option value="ALL" selected="True">ALL</option>
340633249b3d Uploaded
bgruening
parents:
diff changeset
168 <option value="MULTIALLELIC">MULTIALLELIC</option>
340633249b3d Uploaded
bgruening
parents:
diff changeset
169 <option value="BIALLELIC">BIALLELIC</option>
340633249b3d Uploaded
bgruening
parents:
diff changeset
170 </param>
340633249b3d Uploaded
bgruening
parents:
diff changeset
171
340633249b3d Uploaded
bgruening
parents:
diff changeset
172 <repeat name="sample_expressions_repeat" title="Regular expression to select many samples from the ROD tracks provided" help="-se,--sample_expressions &amp;lt;sample_expressions&amp;gt;">
340633249b3d Uploaded
bgruening
parents:
diff changeset
173 <param name="sample_expressions" type="text" label="Regular expression">
340633249b3d Uploaded
bgruening
parents:
diff changeset
174 <sanitizer>
340633249b3d Uploaded
bgruening
parents:
diff changeset
175 <valid initial="string.printable">
340633249b3d Uploaded
bgruening
parents:
diff changeset
176 <remove value="&apos;"/>
340633249b3d Uploaded
bgruening
parents:
diff changeset
177 </valid>
340633249b3d Uploaded
bgruening
parents:
diff changeset
178 <mapping initial="none"/>
340633249b3d Uploaded
bgruening
parents:
diff changeset
179 </sanitizer>
340633249b3d Uploaded
bgruening
parents:
diff changeset
180 </param>
340633249b3d Uploaded
bgruening
parents:
diff changeset
181 </repeat>
340633249b3d Uploaded
bgruening
parents:
diff changeset
182
340633249b3d Uploaded
bgruening
parents:
diff changeset
183 <conditional name="select_random_type">
340633249b3d Uploaded
bgruening
parents:
diff changeset
184 <param name="select_random_type_selector" type="select" label="Select a random subset of variants">
340633249b3d Uploaded
bgruening
parents:
diff changeset
185 <option value="select_all" selected="True">Use all variants</option>
340633249b3d Uploaded
bgruening
parents:
diff changeset
186 <option value="select_random_fraction">Select random fraction</option>
340633249b3d Uploaded
bgruening
parents:
diff changeset
187 <option value="select_random_number">Select random number</option>
340633249b3d Uploaded
bgruening
parents:
diff changeset
188 </param>
340633249b3d Uploaded
bgruening
parents:
diff changeset
189 <when value="select_all">
340633249b3d Uploaded
bgruening
parents:
diff changeset
190 <!-- Do nothing here -->
340633249b3d Uploaded
bgruening
parents:
diff changeset
191 </when>
340633249b3d Uploaded
bgruening
parents:
diff changeset
192 <when value="select_random_fraction">
340633249b3d Uploaded
bgruening
parents:
diff changeset
193 <param name="select_random_fraction" type="float" value="0" label="Fraction" min="0" max="1" help="-fraction,--select_random_fraction &amp;lt;select_random_fraction&amp;gt;"/>
340633249b3d Uploaded
bgruening
parents:
diff changeset
194 </when>
340633249b3d Uploaded
bgruening
parents:
diff changeset
195 <when value="select_random_number">
340633249b3d Uploaded
bgruening
parents:
diff changeset
196 <param name="select_random_number" type="integer" value="0" label="Count" help="-number,--select_random_number &amp;lt;select_random_number&amp;gt;" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
197 </when>
340633249b3d Uploaded
bgruening
parents:
diff changeset
198 </conditional>
340633249b3d Uploaded
bgruening
parents:
diff changeset
199
340633249b3d Uploaded
bgruening
parents:
diff changeset
200 <param name="exclude_non_variants" type="boolean" truevalue="--excludeNonVariants" falsevalue="" label="Don't include loci found to be non-variant after the subsetting procedure" help="-env,--excludeNonVariants" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
201
340633249b3d Uploaded
bgruening
parents:
diff changeset
202 <param name="select_type_to_include" type="select" label="Select only a certain type of variants from the input file" multiple="True" display="checkboxes" help="-selectType,--selectTypeToInclude &amp;lt;selectTypeToInclude&amp;gt;">
340633249b3d Uploaded
bgruening
parents:
diff changeset
203 <option value="INDEL">INDEL</option>
340633249b3d Uploaded
bgruening
parents:
diff changeset
204 <option value="SNP">SNP</option>
340633249b3d Uploaded
bgruening
parents:
diff changeset
205 <option value="MIXED">MIXED</option>
340633249b3d Uploaded
bgruening
parents:
diff changeset
206 <option value="MNP">MNP</option>
340633249b3d Uploaded
bgruening
parents:
diff changeset
207 <option value="SYMBOLIC">SYMBOLIC</option>
340633249b3d Uploaded
bgruening
parents:
diff changeset
208 <option value="NO_VARIATION">NO_VARIATION</option>
340633249b3d Uploaded
bgruening
parents:
diff changeset
209 </param>
340633249b3d Uploaded
bgruening
parents:
diff changeset
210 </expand>
340633249b3d Uploaded
bgruening
parents:
diff changeset
211
340633249b3d Uploaded
bgruening
parents:
diff changeset
212 </inputs>
340633249b3d Uploaded
bgruening
parents:
diff changeset
213 <outputs>
340633249b3d Uploaded
bgruening
parents:
diff changeset
214 <data format="vcf" name="output_vcf" label="${tool.name} on ${on_string} (Variant File)" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
215 <data format="txt" name="output_log" label="${tool.name} on ${on_string} (log)" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
216 </outputs>
340633249b3d Uploaded
bgruening
parents:
diff changeset
217 <tests>
340633249b3d Uploaded
bgruening
parents:
diff changeset
218 <test>
340633249b3d Uploaded
bgruening
parents:
diff changeset
219 <param name="reference_source_selector" value="history" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
220 <param name="ref_file" value="phiX.fasta" ftype="fasta" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
221 <param name="input_variant" value="gatk/gatk_variant_annotator/gatk_variant_annotator_out_1.vcf" ftype="vcf" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
222 <param name="select_expressions_repeat" value="0" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
223 <param name="input_concordance" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
224 <param name="input_discordance" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
225 <param name="exclude_sample_name_repeat" value="0" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
226 <param name="exclude_filtered" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
227 <param name="sample_name_repeat" value="0" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
228 <param name="gatk_param_type_selector" value="basic" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
229 <param name="analysis_param_type_selector" value="basic" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
230 <output name="output_vcf" file="gatk/gatk_variant_select/gatk_variant_select_out_1.vcf" lines_diff="4" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
231 <output name="output_log" file="gatk/gatk_variant_select/gatk_variant_select_out_1.log.contains" compare="contains" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
232 </test>
340633249b3d Uploaded
bgruening
parents:
diff changeset
233 </tests>
340633249b3d Uploaded
bgruening
parents:
diff changeset
234 <help>
340633249b3d Uploaded
bgruening
parents:
diff changeset
235 **What it does**
340633249b3d Uploaded
bgruening
parents:
diff changeset
236
340633249b3d Uploaded
bgruening
parents:
diff changeset
237 Often, a VCF containing many samples and/or variants will need to be subset in order to facilitate certain analyses (e.g. comparing and contrasting cases vs. controls; extracting variant or non-variant loci that meet certain requirements, displaying just a few samples in a browser like IGV, etc.). SelectVariants can be used for this purpose. Given a single VCF file, one or more samples can be extracted from the file (based on a complete sample name or a pattern match). Variants can be further selected by specifying criteria for inclusion, i.e. "DP &gt; 1000" (depth of coverage greater than 1000x), "AF &lt; 0.25" (sites with allele frequency less than 0.25). These JEXL expressions are documented in the `Using JEXL expressions section &lt;http://gatkforums.broadinstitute.org/discussion/1255/what-are-jexl-expressions-and-how-can-i-use-them-with-the-gatk&gt;`_. One can optionally include concordance or discordance tracks for use in selecting overlapping variants.
340633249b3d Uploaded
bgruening
parents:
diff changeset
238
340633249b3d Uploaded
bgruening
parents:
diff changeset
239 For more information on using the SelectVariants module, see this `tool specific page &lt;http://www.broadinstitute.org/gatk/gatkdocs/org_broadinstitute_sting_gatk_walkers_variantutils_SelectVariants.html&gt;`_.
340633249b3d Uploaded
bgruening
parents:
diff changeset
240
340633249b3d Uploaded
bgruening
parents:
diff changeset
241 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
242
340633249b3d Uploaded
bgruening
parents:
diff changeset
243 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
244
340633249b3d Uploaded
bgruening
parents:
diff changeset
245 ------
340633249b3d Uploaded
bgruening
parents:
diff changeset
246
340633249b3d Uploaded
bgruening
parents:
diff changeset
247 **Inputs**
340633249b3d Uploaded
bgruening
parents:
diff changeset
248
340633249b3d Uploaded
bgruening
parents:
diff changeset
249 GenomeAnalysisTK: SelectVariants accepts a VCF input file.
340633249b3d Uploaded
bgruening
parents:
diff changeset
250
340633249b3d Uploaded
bgruening
parents:
diff changeset
251
340633249b3d Uploaded
bgruening
parents:
diff changeset
252 **Outputs**
340633249b3d Uploaded
bgruening
parents:
diff changeset
253
340633249b3d Uploaded
bgruening
parents:
diff changeset
254 The output is in VCF format.
340633249b3d Uploaded
bgruening
parents:
diff changeset
255
340633249b3d Uploaded
bgruening
parents:
diff changeset
256
340633249b3d Uploaded
bgruening
parents:
diff changeset
257 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
258
340633249b3d Uploaded
bgruening
parents:
diff changeset
259 -------
340633249b3d Uploaded
bgruening
parents:
diff changeset
260
340633249b3d Uploaded
bgruening
parents:
diff changeset
261 **Settings**::
340633249b3d Uploaded
bgruening
parents:
diff changeset
262
340633249b3d Uploaded
bgruening
parents:
diff changeset
263
340633249b3d Uploaded
bgruening
parents:
diff changeset
264 out VCFWriter stdout File to which variants should be written
340633249b3d Uploaded
bgruening
parents:
diff changeset
265 variant RodBinding[VariantContext] NA Input VCF file
340633249b3d Uploaded
bgruening
parents:
diff changeset
266 concordance RodBinding[VariantContext] none Output variants that were also called in this comparison track
340633249b3d Uploaded
bgruening
parents:
diff changeset
267 discordance RodBinding[VariantContext] none Output variants that were not called in this comparison track
340633249b3d Uploaded
bgruening
parents:
diff changeset
268 exclude_sample_file Set[File] [] File containing a list of samples (one per line) to exclude. Can be specified multiple times
340633249b3d Uploaded
bgruening
parents:
diff changeset
269 exclude_sample_name Set[String] [] Exclude genotypes from this sample. Can be specified multiple times
340633249b3d Uploaded
bgruening
parents:
diff changeset
270 excludeFiltered boolean false Don't include filtered loci in the analysis
340633249b3d Uploaded
bgruening
parents:
diff changeset
271 excludeNonVariants boolean false Don't include loci found to be non-variant after the subsetting procedure
340633249b3d Uploaded
bgruening
parents:
diff changeset
272 keepIDs File NA Only emit sites whose ID is found in this file (one ID per line)
340633249b3d Uploaded
bgruening
parents:
diff changeset
273 keepOriginalAC boolean false Don't update the AC, AF, or AN values in the INFO field after selecting
340633249b3d Uploaded
bgruening
parents:
diff changeset
274 mendelianViolation Boolean false output mendelian violation sites only
340633249b3d Uploaded
bgruening
parents:
diff changeset
275 mvq double 0.0 Minimum genotype QUAL score for each trio member required to accept a site as a violation
340633249b3d Uploaded
bgruening
parents:
diff changeset
276 remove_fraction_genotypes double 0.0 Selects a fraction (a number between 0 and 1) of the total genotypes at random from the variant track and sets them to nocall
340633249b3d Uploaded
bgruening
parents:
diff changeset
277 restrictAllelesTo NumberAlleleRestriction ALL Select only variants of a particular allelicity. Valid options are ALL (default), MULTIALLELIC or BIALLELIC
340633249b3d Uploaded
bgruening
parents:
diff changeset
278 sample_expressions Set[String] NA Regular expression to select many samples from the ROD tracks provided. Can be specified multiple times
340633249b3d Uploaded
bgruening
parents:
diff changeset
279 sample_file Set[File] NA File containing a list of samples (one per line) to include. Can be specified multiple times
340633249b3d Uploaded
bgruening
parents:
diff changeset
280 sample_name Set[String] [] Include genotypes from this sample. Can be specified multiple times
340633249b3d Uploaded
bgruening
parents:
diff changeset
281 select_expressions ArrayList[String] [] One or more criteria to use when selecting the data
340633249b3d Uploaded
bgruening
parents:
diff changeset
282 select_random_fraction double 0.0 Selects a fraction (a number between 0 and 1) of the total variants at random from the variant track
340633249b3d Uploaded
bgruening
parents:
diff changeset
283 select_random_number int 0 Selects a number of variants at random from the variant track
340633249b3d Uploaded
bgruening
parents:
diff changeset
284 selectTypeToInclude List[Type] [] Select only a certain type of variants from the input file. Valid types are INDEL, SNP, MIXED, MNP, SYMBOLIC, NO_VARIATION. Can be specified multiple times
340633249b3d Uploaded
bgruening
parents:
diff changeset
285
340633249b3d Uploaded
bgruening
parents:
diff changeset
286 @CITATION_SECTION@
340633249b3d Uploaded
bgruening
parents:
diff changeset
287 </help>
4
f244b8209eb8 bug fix release
iuc
parents: 0
diff changeset
288 <expand macro="citations" />
0
340633249b3d Uploaded
bgruening
parents:
diff changeset
289 </tool>