annotate variant_filtration.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_filtration" name="Variant Filtration" version="0.0.7">
340633249b3d Uploaded
bgruening
parents:
diff changeset
2 <description>on 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 "VariantFiltration"
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
340633249b3d Uploaded
bgruening
parents:
diff changeset
20 -o "${output_vcf}"
340633249b3d Uploaded
bgruening
parents:
diff changeset
21
340633249b3d Uploaded
bgruening
parents:
diff changeset
22 #if $reference_source.reference_source_selector != "history":
340633249b3d Uploaded
bgruening
parents:
diff changeset
23 -R "${reference_source.ref_file.fields.path}"
340633249b3d Uploaded
bgruening
parents:
diff changeset
24 #end if
340633249b3d Uploaded
bgruening
parents:
diff changeset
25 '
340633249b3d Uploaded
bgruening
parents:
diff changeset
26 #for $variant_filter in $variant_filters:
340633249b3d Uploaded
bgruening
parents:
diff changeset
27 #set $variant_filter = "--%sExpression '%s' --%sName '%s'" % ( str( $variant_filter.is_genotype_filter ), str( $variant_filter.filter_expression ), str( $variant_filter.is_genotype_filter ), str( $variant_filter.filter_name ) )
340633249b3d Uploaded
bgruening
parents:
diff changeset
28 -o '${ hexlify( $variant_filter ) }'
340633249b3d Uploaded
bgruening
parents:
diff changeset
29 #end for
340633249b3d Uploaded
bgruening
parents:
diff changeset
30
340633249b3d Uploaded
bgruening
parents:
diff changeset
31 #if str( $mask_rod_bind_type.mask_rod_bind_type_selector ) == 'set_mask':
340633249b3d Uploaded
bgruening
parents:
diff changeset
32 -d "--mask:${mask_rod_bind_type.mask_rod_name},%(file_type)s" "${mask_rod_bind_type.input_mask_rod}" "${mask_rod_bind_type.input_mask_rod.ext}" "input_mask_${mask_rod_bind_type.mask_rod_name}"
340633249b3d Uploaded
bgruening
parents:
diff changeset
33 -p '
340633249b3d Uploaded
bgruening
parents:
diff changeset
34 --maskExtension "${mask_rod_bind_type.mask_extension}"
340633249b3d Uploaded
bgruening
parents:
diff changeset
35 --maskName "${mask_rod_bind_type.mask_rod_name}"
340633249b3d Uploaded
bgruening
parents:
diff changeset
36 '
340633249b3d Uploaded
bgruening
parents:
diff changeset
37 #end if
340633249b3d Uploaded
bgruening
parents:
diff changeset
38
340633249b3d Uploaded
bgruening
parents:
diff changeset
39 #include source=$standard_gatk_options#
340633249b3d Uploaded
bgruening
parents:
diff changeset
40
340633249b3d Uploaded
bgruening
parents:
diff changeset
41 ##start analysis specific options
340633249b3d Uploaded
bgruening
parents:
diff changeset
42 #if $cluster_snp_type.cluster_snp_type_selector == "cluster_snp":
340633249b3d Uploaded
bgruening
parents:
diff changeset
43 -p '
340633249b3d Uploaded
bgruening
parents:
diff changeset
44 --clusterSize "${cluster_snp_type.cluster_size}"
340633249b3d Uploaded
bgruening
parents:
diff changeset
45 --clusterWindowSize "${cluster_snp_type.cluster_window_size}"
340633249b3d Uploaded
bgruening
parents:
diff changeset
46 '
340633249b3d Uploaded
bgruening
parents:
diff changeset
47 #end if
340633249b3d Uploaded
bgruening
parents:
diff changeset
48 -p '${missing_values_in_expressions_should_evaluate_as_failing}'
340633249b3d Uploaded
bgruening
parents:
diff changeset
49 </command>
340633249b3d Uploaded
bgruening
parents:
diff changeset
50 <inputs>
340633249b3d Uploaded
bgruening
parents:
diff changeset
51 <conditional name="reference_source">
340633249b3d Uploaded
bgruening
parents:
diff changeset
52 <expand macro="reference_source_selector_param" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
53 <when value="cached">
340633249b3d Uploaded
bgruening
parents:
diff changeset
54 <param name="input_variant" type="data" format="vcf" label="Variant file to annotate" help="-V,--variant &amp;lt;variant&amp;gt;" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
55 <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
56 <options from_data_table="gatk2_picard_indexes">
340633249b3d Uploaded
bgruening
parents:
diff changeset
57 <filter type="data_meta" key="dbkey" ref="input_variant" column="dbkey"/>
340633249b3d Uploaded
bgruening
parents:
diff changeset
58 </options>
340633249b3d Uploaded
bgruening
parents:
diff changeset
59 <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
60 </param>
340633249b3d Uploaded
bgruening
parents:
diff changeset
61 </when>
340633249b3d Uploaded
bgruening
parents:
diff changeset
62 <when value="history"> <!-- FIX ME!!!! -->
340633249b3d Uploaded
bgruening
parents:
diff changeset
63 <param name="input_variant" type="data" format="vcf" label="Variant file to annotate" help="-V,--variant &amp;lt;variant&amp;gt;" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
64 <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
65 </when>
340633249b3d Uploaded
bgruening
parents:
diff changeset
66 </conditional>
340633249b3d Uploaded
bgruening
parents:
diff changeset
67
340633249b3d Uploaded
bgruening
parents:
diff changeset
68
340633249b3d Uploaded
bgruening
parents:
diff changeset
69 <repeat name="variant_filters" title="Variant Filters">
340633249b3d Uploaded
bgruening
parents:
diff changeset
70 <param name="filter_expression" value="AB &lt; 0.2 || MQ0 &gt; 50" type="text" label="Filter expression" help="JEXL formatted expressions (-filter,--filterExpression &amp;lt;filterExpression&amp;gt;)">
340633249b3d Uploaded
bgruening
parents:
diff changeset
71 <sanitizer>
340633249b3d Uploaded
bgruening
parents:
diff changeset
72 <valid initial="string.printable">
340633249b3d Uploaded
bgruening
parents:
diff changeset
73 <remove value="&apos;"/>
340633249b3d Uploaded
bgruening
parents:
diff changeset
74 </valid>
340633249b3d Uploaded
bgruening
parents:
diff changeset
75 <mapping initial="none"/>
340633249b3d Uploaded
bgruening
parents:
diff changeset
76 </sanitizer>
340633249b3d Uploaded
bgruening
parents:
diff changeset
77 </param>
340633249b3d Uploaded
bgruening
parents:
diff changeset
78 <param name="filter_name" value="custom_filter" type="text" label="Filter name" help="-filterName,--filterName &amp;lt;filterName&amp;gt;"/>
340633249b3d Uploaded
bgruening
parents:
diff changeset
79 <param name="is_genotype_filter" type="boolean" truevalue="genotypeFilter" falsevalue="filter" label="Use filter at the individual sample level" help="Use -G_filter,--genotypeFilterExpression &amp;lt;genotypeFilterExpression&amp;gt; and -G_filterName,--genotypeFilterName &amp;lt;genotypeFilterName&amp;gt; for filter type" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
80 </repeat>
340633249b3d Uploaded
bgruening
parents:
diff changeset
81
340633249b3d Uploaded
bgruening
parents:
diff changeset
82
340633249b3d Uploaded
bgruening
parents:
diff changeset
83
340633249b3d Uploaded
bgruening
parents:
diff changeset
84 <conditional name="mask_rod_bind_type">
340633249b3d Uploaded
bgruening
parents:
diff changeset
85 <param name="mask_rod_bind_type_selector" type="select" label="Provide a Mask reference-ordered data file">
340633249b3d Uploaded
bgruening
parents:
diff changeset
86 <option value="set_mask" selected="True">Set maskP</option>
340633249b3d Uploaded
bgruening
parents:
diff changeset
87 <option value="exclude_mask">Don't set mask</option>
340633249b3d Uploaded
bgruening
parents:
diff changeset
88 </param>
340633249b3d Uploaded
bgruening
parents:
diff changeset
89 <when value="exclude_mask">
340633249b3d Uploaded
bgruening
parents:
diff changeset
90 <!-- Do nothing here -->
340633249b3d Uploaded
bgruening
parents:
diff changeset
91 </when>
340633249b3d Uploaded
bgruening
parents:
diff changeset
92 <when value="set_mask">
340633249b3d Uploaded
bgruening
parents:
diff changeset
93 <param name="input_mask_rod" type="data" format="bed,gatk_dbsnp,vcf" label="Mask ROD file" help="--mask &amp;lt;mask&amp;gt;" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
94 <param name="mask_rod_name" type="text" value="Mask" label="Mask Name" help="-maskName,--maskName &amp;lt;maskName&amp;gt;"/>
340633249b3d Uploaded
bgruening
parents:
diff changeset
95 <param name="mask_extension" type="integer" value="0" label="Mask Extension" help="-maskExtend,--maskExtension &amp;lt;maskExtension&amp;gt;"/>
340633249b3d Uploaded
bgruening
parents:
diff changeset
96 </when>
340633249b3d Uploaded
bgruening
parents:
diff changeset
97 </conditional>
340633249b3d Uploaded
bgruening
parents:
diff changeset
98
340633249b3d Uploaded
bgruening
parents:
diff changeset
99
340633249b3d Uploaded
bgruening
parents:
diff changeset
100 <expand macro="gatk_param_type_conditional" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
101
340633249b3d Uploaded
bgruening
parents:
diff changeset
102 <conditional name="cluster_snp_type">
340633249b3d Uploaded
bgruening
parents:
diff changeset
103 <param name="cluster_snp_type_selector" type="select" label="Cluster SNPs">
340633249b3d Uploaded
bgruening
parents:
diff changeset
104 <option value="cluster_snp">Cluster SNPs</option>
340633249b3d Uploaded
bgruening
parents:
diff changeset
105 <option value="do_not_cluster_snp" selected="True">Do not cluster SNPs</option>
340633249b3d Uploaded
bgruening
parents:
diff changeset
106 </param>
340633249b3d Uploaded
bgruening
parents:
diff changeset
107 <when value="do_not_cluster_snp">
340633249b3d Uploaded
bgruening
parents:
diff changeset
108 <!-- Do nothing here -->
340633249b3d Uploaded
bgruening
parents:
diff changeset
109 </when>
340633249b3d Uploaded
bgruening
parents:
diff changeset
110 <when value="cluster_snp">
340633249b3d Uploaded
bgruening
parents:
diff changeset
111 <param name="cluster_size" type="integer" value="3" label="The number of SNPs which make up a cluster" help="-cluster,--clusterSize &amp;lt;clusterSize&amp;gt;"/>
340633249b3d Uploaded
bgruening
parents:
diff changeset
112 <param name="cluster_window_size" type="integer" value="0" label="The window size (in bases) in which to evaluate clustered SNPs" help="-window,--clusterWindowSize &amp;lt;clusterWindowSize&amp;gt;"/>
340633249b3d Uploaded
bgruening
parents:
diff changeset
113 </when>
340633249b3d Uploaded
bgruening
parents:
diff changeset
114 </conditional>
340633249b3d Uploaded
bgruening
parents:
diff changeset
115
340633249b3d Uploaded
bgruening
parents:
diff changeset
116 <param name="missing_values_in_expressions_should_evaluate_as_failing" type="boolean" truevalue="--missingValuesInExpressionsShouldEvaluateAsFailing" falsevalue="" label="Should missing values be considered failing the expression" help="--missingValuesInExpressionsShouldEvaluateAsFailing" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
117
340633249b3d Uploaded
bgruening
parents:
diff changeset
118 </inputs>
340633249b3d Uploaded
bgruening
parents:
diff changeset
119 <outputs>
340633249b3d Uploaded
bgruening
parents:
diff changeset
120 <data format="vcf" name="output_vcf" label="${tool.name} on ${on_string} (Variant File)" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
121 <data format="txt" name="output_log" label="${tool.name} on ${on_string} (log)" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
122 </outputs>
340633249b3d Uploaded
bgruening
parents:
diff changeset
123 <tests>
340633249b3d Uploaded
bgruening
parents:
diff changeset
124 <test>
340633249b3d Uploaded
bgruening
parents:
diff changeset
125 <param name="reference_source_selector" value="history" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
126 <param name="ref_file" value="phiX.fasta" ftype="fasta" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
127 <param name="input_variant" value="gatk/gatk_variant_annotator/gatk_variant_annotator_out_1.vcf" ftype="vcf" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
128 <param name="filter_expression" value="MQ &lt; 37.74 || MQ0 &gt; 50" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
129 <param name="filter_name" value="Galaxy_filter" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
130 <param name="is_genotype_filter" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
131 <param name="mask_rod_bind_type_selector" value="set_mask" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
132 <param name="input_mask_rod" value="gatk/fake_phiX_variant_locations.bed" ftype="bed" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
133 <param name="mask_rod_name" value="." />
340633249b3d Uploaded
bgruening
parents:
diff changeset
134 <param name="mask_extension" value="0" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
135 <param name="gatk_param_type_selector" value="basic" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
136 <param name="cluster_snp_type_selector" value="do_not_cluster_snp" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
137 <param name="missing_values_in_expressions_should_evaluate_as_failing" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
138 <output name="output_vcf" file="gatk/gatk_variant_annotator/gatk_variant_annotator_out_1.vcf" lines_diff="4" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
139 <output name="output_log" file="gatk/gatk_variant_filtration/gatk_variant_filtration_out_1.log.contains" compare="contains" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
140 </test>
340633249b3d Uploaded
bgruening
parents:
diff changeset
141 </tests>
340633249b3d Uploaded
bgruening
parents:
diff changeset
142 <help>
340633249b3d Uploaded
bgruening
parents:
diff changeset
143 **What it does**
340633249b3d Uploaded
bgruening
parents:
diff changeset
144
340633249b3d Uploaded
bgruening
parents:
diff changeset
145 Filters variant calls using a number of user-selectable, parameterizable criteria.
340633249b3d Uploaded
bgruening
parents:
diff changeset
146
340633249b3d Uploaded
bgruening
parents:
diff changeset
147 For more information on using the VariantFiltration module, see this `tool specific page &lt;http://www.broadinstitute.org/gatk/gatkdocs/org_broadinstitute_sting_gatk_walkers_filters_VariantFiltration.html&gt;`_.
340633249b3d Uploaded
bgruening
parents:
diff changeset
148
340633249b3d Uploaded
bgruening
parents:
diff changeset
149 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
150
340633249b3d Uploaded
bgruening
parents:
diff changeset
151 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
152
340633249b3d Uploaded
bgruening
parents:
diff changeset
153 ------
340633249b3d Uploaded
bgruening
parents:
diff changeset
154
340633249b3d Uploaded
bgruening
parents:
diff changeset
155 **Inputs**
340633249b3d Uploaded
bgruening
parents:
diff changeset
156
340633249b3d Uploaded
bgruening
parents:
diff changeset
157 GenomeAnalysisTK: VariantFiltration accepts a VCF input file.
340633249b3d Uploaded
bgruening
parents:
diff changeset
158
340633249b3d Uploaded
bgruening
parents:
diff changeset
159
340633249b3d Uploaded
bgruening
parents:
diff changeset
160 **Outputs**
340633249b3d Uploaded
bgruening
parents:
diff changeset
161
340633249b3d Uploaded
bgruening
parents:
diff changeset
162 The output is in VCF format.
340633249b3d Uploaded
bgruening
parents:
diff changeset
163
340633249b3d Uploaded
bgruening
parents:
diff changeset
164 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
165
340633249b3d Uploaded
bgruening
parents:
diff changeset
166 -------
340633249b3d Uploaded
bgruening
parents:
diff changeset
167
340633249b3d Uploaded
bgruening
parents:
diff changeset
168 **Settings**::
340633249b3d Uploaded
bgruening
parents:
diff changeset
169
340633249b3d Uploaded
bgruening
parents:
diff changeset
170
340633249b3d Uploaded
bgruening
parents:
diff changeset
171 filterExpression One or more expression used with INFO fields to filter (see wiki docs for more info)
340633249b3d Uploaded
bgruening
parents:
diff changeset
172 filterName Names to use for the list of filters (must be a 1-to-1 mapping); this name is put in the FILTER field for variants that get filtered
340633249b3d Uploaded
bgruening
parents:
diff changeset
173 genotypeFilterExpression One or more expression used with FORMAT (sample/genotype-level) fields to filter (see wiki docs for more info)
340633249b3d Uploaded
bgruening
parents:
diff changeset
174 genotypeFilterName Names to use for the list of sample/genotype filters (must be a 1-to-1 mapping); this name is put in the FILTER field for variants that get filtered
340633249b3d Uploaded
bgruening
parents:
diff changeset
175 clusterSize The number of SNPs which make up a cluster (see also --clusterWindowSize); [default:3]
340633249b3d Uploaded
bgruening
parents:
diff changeset
176 clusterWindowSize The window size (in bases) in which to evaluate clustered SNPs (to disable the clustered SNP filter, set this value to less than 1); [default:0]
340633249b3d Uploaded
bgruening
parents:
diff changeset
177 maskName The text to put in the FILTER field if a 'mask' rod is provided and overlaps with a variant call; [default:'Mask']
340633249b3d Uploaded
bgruening
parents:
diff changeset
178 missingValuesInExpressionsShouldEvaluateAsFailing When evaluating the JEXL expressions, should missing values be considered failing the expression (by default they are considered passing)?
340633249b3d Uploaded
bgruening
parents:
diff changeset
179
340633249b3d Uploaded
bgruening
parents:
diff changeset
180 @CITATION_SECTION@
340633249b3d Uploaded
bgruening
parents:
diff changeset
181 </help>
340633249b3d Uploaded
bgruening
parents:
diff changeset
182 </tool>