Mercurial > repos > iuc > gatk2

comparison variant_apply_recalibration.xml @ 0:340633249b3d draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Uploaded
author bgruening
date Mon, 02 Dec 2013 06:18:36 -0500
parents
children f244b8209eb8
comparison
equal deleted inserted replaced
-1:000000000000 0:340633249b3d
1 <tool id="gatk2_variant_apply_recalibration" name="Apply Variant Recalibration" version="0.0.7">
2 <description></description>
3 <expand macro="requirements" />
4 <macros>
5 <import>gatk2_macros.xml</import>
6 </macros>
7 <command interpreter="python">
8 gatk2_wrapper.py
9 --stdout "${output_log}"
10 #for $var_count, $variant in enumerate( $reference_source.variants ):
11 -d "--input:input_${var_count},%(file_type)s" "${variant.input_variants}" "${variant.input_variants.ext}" "input_variants_${var_count}"
12 #end for
13 -p '
14 @JAR_PATH@
15 -T "ApplyRecalibration"
16 \$GATK2_SITE_OPTIONS
17
18 @THREADS@
19
20 #if $reference_source.reference_source_selector != "history":
21 -R "${reference_source.ref_file.fields.path}"
22 #end if
23 --recal_file "${reference_source.input_recal}"
24 --tranches_file "${reference_source.input_tranches}"
25 --out "${output_variants}"
26 '
27
28 #include source=$standard_gatk_options#
29
30 ##start analysis specific options
31 -p '
32 --mode "${mode}"
33
34 #for $ignore_filter in $ignore_filters:
35 #set $ignore_filter_name = str( $ignore_filter.ignore_filter_type.ignore_filter_type_selector )
36 #if $ignore_filter_name == "custom":
37 #set $ignore_filter_name = str( $ignore_filter.ignore_filter_type.filter_name )
38 #end if
39 --ignore_filter "${ignore_filter_name}"
40 #end for
41 --ts_filter_level "${ts_filter_level}"
42 '
43 </command>
44 <inputs>
45 <conditional name="reference_source">
46 <expand macro="reference_source_selector_param" />
47 <when value="cached">
48 <repeat name="variants" title="Variant" min="1" help="-input,--input &amp;lt;input&amp;gt;">
49 <param name="input_variants" type="data" format="vcf" label="Variant file to annotate"/>
50 </repeat>
51 <param name="input_recal" type="data" format="gatk_recal" label="Variant Recalibration file" help="-recalFile,--recal_file &amp;lt;recal_file&amp;gt;" />
52 <param name="input_tranches" type="data" format="gatk_tranche" label="Variant Tranches file" help="-tranchesFile,--tranches_file &amp;lt;tranches_file&amp;gt;" />
53 <param name="ref_file" type="select" label="Using reference genome" help="-R,--reference_sequence &amp;lt;reference_sequence&amp;gt;">
54 <options from_data_table="gatk2_picard_indexes">
55 <!-- <filter type="data_meta" key="dbkey" ref="variants[0].input_variants" column="dbkey"/> -->
56 </options>
57 <validator type="no_options" message="A built-in reference genome is not available for the build associated with the selected input file"/>
58 </param>
59 </when>
60 <when value="history"> <!-- FIX ME!!!! -->
61 <repeat name="variants" title="Variant" min="1" help="-input,--input &amp;lt;input&amp;gt;">
62 <param name="input_variants" type="data" format="vcf" label="Variant file to annotate" />
63 </repeat>
64 <param name="input_recal" type="data" format="gatk_recal" label="Variant Recalibration file" help="-recalFile,--recal_file &amp;lt;recal_file&amp;gt;" />
65 <param name="input_tranches" type="data" format="gatk_tranche" label="Variant Tranches file" help="-tranchesFile,--tranches_file &amp;lt;tranches_file&amp;gt;" />
66 <param name="ref_file" type="data" format="fasta" label="Using reference file" help="-R,--reference_sequence &amp;lt;reference_sequence&amp;gt;" />
67 </when>
68 </conditional>
69
70 <expand macro="gatk_param_type_conditional" />
71
72 <param name="mode" type="select" label="Recalibration mode" help="-mode,--mode &amp;lt;mode&amp;gt;">
73 <option value="SNP" selected="True">SNP</option>
74 <option value="INDEL">INDEL</option>
75 <option value="BOTH">BOTH</option>
76 </param>
77 <repeat name="ignore_filters" title="Ignore Filter" help="-ignoreFilter,--ignore_filter &amp;lt;ignore_filter&amp;gt;">
78 <conditional name="ignore_filter_type">
79 <param name="ignore_filter_type_selector" type="select" label="Filter Type">
80 <option value="HARD_TO_VALIDATE">HARD_TO_VALIDATE</option>
81 <option value="LowQual" >LowQual</option>
82 <option value="custom" selected="True">Other</option>
83 </param>
84 <when value="custom">
85 <param name="filter_name" type="text" value="" label="Filter name"/>
86 </when>
87 <when value="HARD_TO_VALIDATE" />
88 <when value="LowQual" />
89 </conditional>
90 </repeat>
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;"/>
92 </inputs>
93 <outputs>
94 <data format="vcf" name="output_variants" label="${tool.name} on ${on_string} (Variants File)" />
95 <data format="txt" name="output_log" label="${tool.name} on ${on_string} (log)" />
96 </outputs>
97 <tests>
98 <!-- ADD TESTS -->
99 </tests>
100 <help>
101 **What it does**
102
103 Applies cuts to the input vcf file (by adding filter lines) to achieve the desired novel FDR levels which were specified during VariantRecalibration
104
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;`_.
106
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;`_.
108
109 If you encounter errors, please view the `GATK FAQ &lt;http://www.broadinstitute.org/gatk/guide/topic?name=faqs&gt;`_.
110
111 ------
112
113 **Inputs**
114
115 GenomeAnalysisTK: ApplyRecalibration accepts a variant input file, a recalibration file and a tranches file.
116
117
118 **Outputs**
119
120 The output is in VCF format.
121
122 Go `here &lt;http://www.broadinstitute.org/gatk/guide/topic?name=intro&gt;`_ for details on GATK file formats.
123
124 -------
125
126 **Settings**::
127
128
129 recal_file The output recal file used by ApplyRecalibration
130 tranches_file The input tranches file describing where to cut the data
131 out The output filtered, recalibrated VCF file
132 ts_filter_level The truth sensitivity level at which to start filtering
133 ignore_filter If specified the optimizer will use variants even if the specified filter name is marked in the input VCF file
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)
135
136 @CITATION_SECTION@
137 </help>
138 </tool>