annotate variant_apply_recalibration.xml @ 3:2553f84b8174 draft

Uploaded
author iuc
date Wed, 19 Feb 2014 04:39:38 -0500
parents 340633249b3d
children f244b8209eb8
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_apply_recalibration" name="Apply Variant Recalibration" 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 gatk2_wrapper.py
340633249b3d Uploaded
bgruening
parents:
diff changeset
9 --stdout "${output_log}"
340633249b3d Uploaded
bgruening
parents:
diff changeset
10 #for $var_count, $variant in enumerate( $reference_source.variants ):
340633249b3d Uploaded
bgruening
parents:
diff changeset
11 -d "--input:input_${var_count},%(file_type)s" "${variant.input_variants}" "${variant.input_variants.ext}" "input_variants_${var_count}"
340633249b3d Uploaded
bgruening
parents:
diff changeset
12 #end for
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 "ApplyRecalibration"
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 #if $reference_source.reference_source_selector != "history":
340633249b3d Uploaded
bgruening
parents:
diff changeset
21 -R "${reference_source.ref_file.fields.path}"
340633249b3d Uploaded
bgruening
parents:
diff changeset
22 #end if
340633249b3d Uploaded
bgruening
parents:
diff changeset
23 --recal_file "${reference_source.input_recal}"
340633249b3d Uploaded
bgruening
parents:
diff changeset
24 --tranches_file "${reference_source.input_tranches}"
340633249b3d Uploaded
bgruening
parents:
diff changeset
25 --out "${output_variants}"
340633249b3d Uploaded
bgruening
parents:
diff changeset
26 '
340633249b3d Uploaded
bgruening
parents:
diff changeset
27
340633249b3d Uploaded
bgruening
parents:
diff changeset
28 #include source=$standard_gatk_options#
340633249b3d Uploaded
bgruening
parents:
diff changeset
29
340633249b3d Uploaded
bgruening
parents:
diff changeset
30 ##start analysis specific options
340633249b3d Uploaded
bgruening
parents:
diff changeset
31 -p '
340633249b3d Uploaded
bgruening
parents:
diff changeset
32 --mode "${mode}"
340633249b3d Uploaded
bgruening
parents:
diff changeset
33
340633249b3d Uploaded
bgruening
parents:
diff changeset
34 #for $ignore_filter in $ignore_filters:
340633249b3d Uploaded
bgruening
parents:
diff changeset
35 #set $ignore_filter_name = str( $ignore_filter.ignore_filter_type.ignore_filter_type_selector )
340633249b3d Uploaded
bgruening
parents:
diff changeset
36 #if $ignore_filter_name == "custom":
340633249b3d Uploaded
bgruening
parents:
diff changeset
37 #set $ignore_filter_name = str( $ignore_filter.ignore_filter_type.filter_name )
340633249b3d Uploaded
bgruening
parents:
diff changeset
38 #end if
340633249b3d Uploaded
bgruening
parents:
diff changeset
39 --ignore_filter "${ignore_filter_name}"
340633249b3d Uploaded
bgruening
parents:
diff changeset
40 #end for
340633249b3d Uploaded
bgruening
parents:
diff changeset
41 --ts_filter_level "${ts_filter_level}"
340633249b3d Uploaded
bgruening
parents:
diff changeset
42 '
340633249b3d Uploaded
bgruening
parents:
diff changeset
43 </command>
340633249b3d Uploaded
bgruening
parents:
diff changeset
44 <inputs>
340633249b3d Uploaded
bgruening
parents:
diff changeset
45 <conditional name="reference_source">
340633249b3d Uploaded
bgruening
parents:
diff changeset
46 <expand macro="reference_source_selector_param" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
47 <when value="cached">
340633249b3d Uploaded
bgruening
parents:
diff changeset
48 <repeat name="variants" title="Variant" min="1" help="-input,--input &amp;lt;input&amp;gt;">
340633249b3d Uploaded
bgruening
parents:
diff changeset
49 <param name="input_variants" type="data" format="vcf" label="Variant file to annotate"/>
340633249b3d Uploaded
bgruening
parents:
diff changeset
50 </repeat>
340633249b3d Uploaded
bgruening
parents:
diff changeset
51 <param name="input_recal" type="data" format="gatk_recal" label="Variant Recalibration file" help="-recalFile,--recal_file &amp;lt;recal_file&amp;gt;" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
52 <param name="input_tranches" type="data" format="gatk_tranche" label="Variant Tranches file" help="-tranchesFile,--tranches_file &amp;lt;tranches_file&amp;gt;" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
53 <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
54 <options from_data_table="gatk2_picard_indexes">
340633249b3d Uploaded
bgruening
parents:
diff changeset
55 <!-- <filter type="data_meta" key="dbkey" ref="variants[0].input_variants" column="dbkey"/> -->
340633249b3d Uploaded
bgruening
parents:
diff changeset
56 </options>
340633249b3d Uploaded
bgruening
parents:
diff changeset
57 <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
58 </param>
340633249b3d Uploaded
bgruening
parents:
diff changeset
59 </when>
340633249b3d Uploaded
bgruening
parents:
diff changeset
60 <when value="history"> <!-- FIX ME!!!! -->
340633249b3d Uploaded
bgruening
parents:
diff changeset
61 <repeat name="variants" title="Variant" min="1" help="-input,--input &amp;lt;input&amp;gt;">
340633249b3d Uploaded
bgruening
parents:
diff changeset
62 <param name="input_variants" type="data" format="vcf" label="Variant file to annotate" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
63 </repeat>
340633249b3d Uploaded
bgruening
parents:
diff changeset
64 <param name="input_recal" type="data" format="gatk_recal" label="Variant Recalibration file" help="-recalFile,--recal_file &amp;lt;recal_file&amp;gt;" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
65 <param name="input_tranches" type="data" format="gatk_tranche" label="Variant Tranches file" help="-tranchesFile,--tranches_file &amp;lt;tranches_file&amp;gt;" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
66 <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
67 </when>
340633249b3d Uploaded
bgruening
parents:
diff changeset
68 </conditional>
340633249b3d Uploaded
bgruening
parents:
diff changeset
69
340633249b3d Uploaded
bgruening
parents:
diff changeset
70 <expand macro="gatk_param_type_conditional" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
71
340633249b3d Uploaded
bgruening
parents:
diff changeset
72 <param name="mode" type="select" label="Recalibration mode" help="-mode,--mode &amp;lt;mode&amp;gt;">
340633249b3d Uploaded
bgruening
parents:
diff changeset
73 <option value="SNP" selected="True">SNP</option>
340633249b3d Uploaded
bgruening
parents:
diff changeset
74 <option value="INDEL">INDEL</option>
340633249b3d Uploaded
bgruening
parents:
diff changeset
75 <option value="BOTH">BOTH</option>
340633249b3d Uploaded
bgruening
parents:
diff changeset
76 </param>
340633249b3d Uploaded
bgruening
parents:
diff changeset
77 <repeat name="ignore_filters" title="Ignore Filter" help="-ignoreFilter,--ignore_filter &amp;lt;ignore_filter&amp;gt;">
340633249b3d Uploaded
bgruening
parents:
diff changeset
78 <conditional name="ignore_filter_type">
340633249b3d Uploaded
bgruening
parents:
diff changeset
79 <param name="ignore_filter_type_selector" type="select" label="Filter Type">
340633249b3d Uploaded
bgruening
parents:
diff changeset
80 <option value="HARD_TO_VALIDATE">HARD_TO_VALIDATE</option>
340633249b3d Uploaded
bgruening
parents:
diff changeset
81 <option value="LowQual" >LowQual</option>
340633249b3d Uploaded
bgruening
parents:
diff changeset
82 <option value="custom" selected="True">Other</option>
340633249b3d Uploaded
bgruening
parents:
diff changeset
83 </param>
340633249b3d Uploaded
bgruening
parents:
diff changeset
84 <when value="custom">
340633249b3d Uploaded
bgruening
parents:
diff changeset
85 <param name="filter_name" type="text" value="" label="Filter name"/>
340633249b3d Uploaded
bgruening
parents:
diff changeset
86 </when>
340633249b3d Uploaded
bgruening
parents:
diff changeset
87 <when value="HARD_TO_VALIDATE" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
88 <when value="LowQual" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
89 </conditional>
340633249b3d Uploaded
bgruening
parents:
diff changeset
90 </repeat>
340633249b3d Uploaded
bgruening
parents:
diff changeset
91 <param name="ts_filter_level" type="float" label="truth sensitivity level at which to start filtering, used here to indicate filtered variants in plots" value="99.0" help="-ts_filter_level,--ts_filter_level &amp;lt;ts_filter_level&amp;gt;"/>
340633249b3d Uploaded
bgruening
parents:
diff changeset
92 </inputs>
340633249b3d Uploaded
bgruening
parents:
diff changeset
93 <outputs>
340633249b3d Uploaded
bgruening
parents:
diff changeset
94 <data format="vcf" name="output_variants" label="${tool.name} on ${on_string} (Variants File)" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
95 <data format="txt" name="output_log" label="${tool.name} on ${on_string} (log)" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
96 </outputs>
340633249b3d Uploaded
bgruening
parents:
diff changeset
97 <tests>
340633249b3d Uploaded
bgruening
parents:
diff changeset
98 <!-- ADD TESTS -->
340633249b3d Uploaded
bgruening
parents:
diff changeset
99 </tests>
340633249b3d Uploaded
bgruening
parents:
diff changeset
100 <help>
340633249b3d Uploaded
bgruening
parents:
diff changeset
101 **What it does**
340633249b3d Uploaded
bgruening
parents:
diff changeset
102
340633249b3d Uploaded
bgruening
parents:
diff changeset
103 Applies cuts to the input vcf file (by adding filter lines) to achieve the desired novel FDR levels which were specified during VariantRecalibration
340633249b3d Uploaded
bgruening
parents:
diff changeset
104
340633249b3d Uploaded
bgruening
parents:
diff changeset
105 For more information on using the ApplyRecalibration module, see this `tool specific page &lt;http://www.broadinstitute.org/gatk/gatkdocs/org_broadinstitute_sting_gatk_walkers_variantrecalibration_ApplyRecalibration.html&gt;`_.
340633249b3d Uploaded
bgruening
parents:
diff changeset
106
340633249b3d Uploaded
bgruening
parents:
diff changeset
107 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
108
340633249b3d Uploaded
bgruening
parents:
diff changeset
109 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
110
340633249b3d Uploaded
bgruening
parents:
diff changeset
111 ------
340633249b3d Uploaded
bgruening
parents:
diff changeset
112
340633249b3d Uploaded
bgruening
parents:
diff changeset
113 **Inputs**
340633249b3d Uploaded
bgruening
parents:
diff changeset
114
340633249b3d Uploaded
bgruening
parents:
diff changeset
115 GenomeAnalysisTK: ApplyRecalibration accepts a variant input file, a recalibration file and a tranches file.
340633249b3d Uploaded
bgruening
parents:
diff changeset
116
340633249b3d Uploaded
bgruening
parents:
diff changeset
117
340633249b3d Uploaded
bgruening
parents:
diff changeset
118 **Outputs**
340633249b3d Uploaded
bgruening
parents:
diff changeset
119
340633249b3d Uploaded
bgruening
parents:
diff changeset
120 The output is in VCF format.
340633249b3d Uploaded
bgruening
parents:
diff changeset
121
340633249b3d Uploaded
bgruening
parents:
diff changeset
122 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
123
340633249b3d Uploaded
bgruening
parents:
diff changeset
124 -------
340633249b3d Uploaded
bgruening
parents:
diff changeset
125
340633249b3d Uploaded
bgruening
parents:
diff changeset
126 **Settings**::
340633249b3d Uploaded
bgruening
parents:
diff changeset
127
340633249b3d Uploaded
bgruening
parents:
diff changeset
128
340633249b3d Uploaded
bgruening
parents:
diff changeset
129 recal_file The output recal file used by ApplyRecalibration
340633249b3d Uploaded
bgruening
parents:
diff changeset
130 tranches_file The input tranches file describing where to cut the data
340633249b3d Uploaded
bgruening
parents:
diff changeset
131 out The output filtered, recalibrated VCF file
340633249b3d Uploaded
bgruening
parents:
diff changeset
132 ts_filter_level The truth sensitivity level at which to start filtering
340633249b3d Uploaded
bgruening
parents:
diff changeset
133 ignore_filter If specified the optimizer will use variants even if the specified filter name is marked in the input VCF file
340633249b3d Uploaded
bgruening
parents:
diff changeset
134 mode Recalibration mode to employ: 1.) SNP for recalibrating only SNPs (emitting indels untouched in the output VCF); 2.) INDEL for indels; and 3.) BOTH for recalibrating both SNPs and indels simultaneously. (SNP|INDEL|BOTH)
340633249b3d Uploaded
bgruening
parents:
diff changeset
135
340633249b3d Uploaded
bgruening
parents:
diff changeset
136 @CITATION_SECTION@
340633249b3d Uploaded
bgruening
parents:
diff changeset
137 </help>
340633249b3d Uploaded
bgruening
parents:
diff changeset
138 </tool>