Mercurial > repos > devteam > variant_filtration

comparison gatk_macros.xml @ 0:da6e2503c62d draft default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Imported from capsule None
author devteam
date Tue, 01 Apr 2014 10:50:10 -0400
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:da6e2503c62d
1 <macros>
2 <template name="standard_gatk_options">
3 ##start standard gatk options
4 #if $gatk_param_type.gatk_param_type_selector == "advanced":
5 #for $pedigree in $gatk_param_type.pedigree:
6 -p '--pedigree "${pedigree.pedigree_file}"'
7 #end for
8 #for $pedigree_string in $gatk_param_type.pedigree_string_repeat:
9 -p '--pedigreeString "${pedigree_string.pedigree_string}"'
10 #end for
11 -p '--pedigreeValidationType "${gatk_param_type.pedigree_validation_type}"'
12 #for $read_filter in $gatk_param_type.read_filter:
13 -p '--read_filter "${read_filter.read_filter_type.read_filter_type_selector}"
14 ###raise Exception( str( dir( $read_filter ) ) )
15 #for $name, $param in $read_filter.read_filter_type.iteritems():
16 #if $name not in [ "__current_case__", "read_filter_type_selector" ]:
17 #if hasattr( $param.input, 'truevalue' ):
18 ${param}
19 #else:
20 --${name} "${param}"
21 #end if
22 #end if
23 #end for
24 '
25 #end for
26 #for $interval_count, $input_intervals in enumerate( $gatk_param_type.input_interval_repeat ):
27 -d "--intervals" "${input_intervals.input_intervals}" "${input_intervals.input_intervals.ext}" "input_intervals_${interval_count}"
28 #end for
29
30 #for $interval_count, $input_intervals in enumerate( $gatk_param_type.input_exclude_interval_repeat ):
31 -d "--excludeIntervals" "${input_intervals.input_exclude_intervals}" "${input_intervals.input_exclude_intervals.ext}" "input_exlude_intervals_${interval_count}"
32 #end for
33
34 -p '--interval_set_rule "${gatk_param_type.interval_set_rule}"'
35
36 -p '--downsampling_type "${gatk_param_type.downsampling_type.downsampling_type_selector}"'
37 #if str( $gatk_param_type.downsampling_type.downsampling_type_selector ) != "NONE":
38 -p '--${gatk_param_type.downsampling_type.downsample_to_type.downsample_to_type_selector} "${gatk_param_type.downsampling_type.downsample_to_type.downsample_to_value}"'
39 #end if
40 -p '
41 --baq "${gatk_param_type.baq}"
42 --baqGapOpenPenalty "${gatk_param_type.baq_gap_open_penalty}"
43 ${gatk_param_type.use_original_qualities}
44 --defaultBaseQualities "${gatk_param_type.default_base_qualities}"
45 --validation_strictness "${gatk_param_type.validation_strictness}"
46 --interval_merging "${gatk_param_type.interval_merging}"
47 ${gatk_param_type.disable_experimental_low_memory_sharding}
48 ${gatk_param_type.non_deterministic_random_seed}
49 '
50 #for $rg_black_list_count, $rg_black_list in enumerate( $gatk_param_type.read_group_black_list_repeat ):
51 #if $rg_black_list.read_group_black_list_type.read_group_black_list_type_selector == "file":
52 -d "--read_group_black_list" "${rg_black_list.read_group_black_list_type.read_group_black_list}" "txt" "input_read_group_black_list_${rg_black_list_count}"
53 #else
54 -p '--read_group_black_list "${rg_black_list.read_group_black_list_type.read_group_black_list}"'
55 #end if
56 #end for
57 #end if
58
59 #if str( $reference_source.reference_source_selector ) == "history":
60 -d "-R" "${reference_source.ref_file}" "${reference_source.ref_file.ext}" "gatk_input"
61 #end if
62 ##end standard gatk options
63 </template>
64 <xml name="gatk_param_type_conditional">
65 <conditional name="gatk_param_type">
66 <param name="gatk_param_type_selector" type="select" label="Basic or Advanced GATK options">
67 <option value="basic" selected="True">Basic</option>
68 <option value="advanced">Advanced</option>
69 </param>
70 <when value="basic">
71 <!-- Do nothing here -->
72 </when>
73 <when value="advanced">
74 <repeat name="pedigree" title="Pedigree file" help="-ped,--pedigree &amp;lt;pedigree&amp;gt;">
75 <param name="pedigree_file" type="data" format="txt" label="Pedigree files for samples"/>
76 </repeat>
77 <repeat name="pedigree_string_repeat" title="Pedigree string" help="-pedString,--pedigreeString &amp;lt;pedigreeString&amp;gt;">
78 <param name="pedigree_string" type="text" value="" label="Pedigree string for samples"/>
79 </repeat>
80 <param name="pedigree_validation_type" type="select" label="How strict should we be in validating the pedigree information" help="-pedValidationType,--pedigreeValidationType &amp;lt;pedigreeValidationType&amp;gt;">
81 <option value="STRICT" selected="True">STRICT</option>
82 <option value="SILENT">SILENT</option>
83 </param>
84 <repeat name="read_filter" title="Read Filter" help="-rf,--read_filter &amp;lt;read_filter&amp;gt;">
85 <conditional name="read_filter_type">
86 <param name="read_filter_type_selector" type="select" label="Read Filter Type">
87 <option value="BadCigar">BadCigar</option>
88 <option value="BadMate">BadMate</option>
89 <option value="DuplicateRead">DuplicateRead</option>
90 <option value="FailsVendorQualityCheck">FailsVendorQualityCheck</option>
91 <option value="MalformedRead">MalformedRead</option>
92 <option value="MappingQuality">MappingQuality</option>
93 <option value="MappingQualityUnavailable">MappingQualityUnavailable</option>
94 <option value="MappingQualityZero">MappingQualityZero</option>
95 <option value="MateSameStrand">MateSameStrand</option>
96 <option value="MaxInsertSize">MaxInsertSize</option>
97 <option value="MaxReadLength" selected="True">MaxReadLength</option>
98 <option value="MissingReadGroup">MissingReadGroup</option>
99 <option value="NoOriginalQualityScores">NoOriginalQualityScores</option>
100 <option value="NotPrimaryAlignment">NotPrimaryAlignment</option>
101 <option value="Platform454">Platform454</option>
102 <option value="Platform">Platform</option>
103 <option value="PlatformUnit">PlatformUnit</option>
104 <option value="ReadGroupBlackList">ReadGroupBlackList</option>
105 <option value="ReadName">ReadName</option>
106 <option value="ReadStrand">ReadStrand</option>
107 <option value="ReassignMappingQuality">ReassignMappingQuality</option>
108 <option value="Sample">Sample</option>
109 <option value="SingleReadGroup">SingleReadGroup</option>
110 <option value="UnmappedRead">UnmappedRead</option>
111 </param>
112 <when value="BadCigar">
113 <!-- no extra options -->
114 </when>
115 <when value="BadMate">
116 <!-- no extra options -->
117 </when>
118 <when value="DuplicateRead">
119 <!-- no extra options -->
120 </when>
121 <when value="FailsVendorQualityCheck">
122 <!-- no extra options -->
123 </when>
124 <when value="MalformedRead">
125 <!-- no extra options -->
126 </when>
127 <when value="MappingQuality">
128 <param name="min_mapping_quality_score" type="integer" value="10" label="Minimum read mapping quality required to consider a read for calling"/>
129 </when>
130 <when value="MappingQualityUnavailable">
131 <!-- no extra options -->
132 </when>
133 <when value="MappingQualityZero">
134 <!-- no extra options -->
135 </when>
136 <when value="MateSameStrand">
137 <!-- no extra options -->
138 </when>
139 <when value="MaxInsertSize">
140 <param name="maxInsertSize" type="integer" value="1000000" label="Discard reads with insert size greater than the specified value"/>
141 </when>
142 <when value="MaxReadLength">
143 <param name="maxReadLength" type="integer" value="76" label="Max Read Length"/>
144 </when>
145 <when value="MissingReadGroup">
146 <!-- no extra options -->
147 </when>
148 <when value="NoOriginalQualityScores">
149 <!-- no extra options -->
150 </when>
151 <when value="NotPrimaryAlignment">
152 <!-- no extra options -->
153 </when>
154 <when value="Platform454">
155 <!-- no extra options -->
156 </when>
157 <when value="Platform">
158 <param name="PLFilterName" type="text" value="" label="Discard reads with RG:PL attribute containing this string"/>
159 </when>
160 <when value="PlatformUnit">
161 <!-- no extra options -->
162 </when>
163 <when value="ReadGroupBlackList">
164 <!-- no extra options -->
165 </when>
166 <when value="ReadName">
167 <param name="readName" type="text" value="" label="Filter out all reads except those with this read name"/>
168 </when>
169 <when value="ReadStrand">
170 <param name="filterPositive" type="boolean" truevalue="--filterPositive" falsevalue="" label="Discard reads on the forward strand"/>
171 </when>
172 <when value="ReassignMappingQuality">
173 <param name="default_mapping_quality" type="integer" value="60" label="Default read mapping quality to assign to all reads"/>
174 </when>
175 <when value="Sample">
176 <param name="sample_to_keep" type="text" value="" label="The name of the sample(s) to keep, filtering out all others"/>
177 </when>
178 <when value="SingleReadGroup">
179 <param name="read_group_to_keep" type="integer" value="76" label="The name of the read group to keep, filtering out all others"/>
180 </when>
181 <when value="UnmappedRead">
182 <!-- no extra options -->
183 </when>
184 </conditional>
185 </repeat>
186 <repeat name="input_interval_repeat" title="Operate on Genomic intervals" help="-L,--intervals &amp;lt;intervals&amp;gt;">
187 <param name="input_intervals" type="data" format="bed,gatk_interval,picard_interval_list,vcf" label="Genomic intervals" />
188 </repeat>
189 <repeat name="input_exclude_interval_repeat" title="Exclude Genomic intervals" help="-XL,--excludeIntervals &amp;lt;excludeIntervals&amp;gt;">
190 <param name="input_exclude_intervals" type="data" format="bed,gatk_interval,picard_interval_list,vcf" label="Genomic intervals" />
191 </repeat>
192
193 <param name="interval_set_rule" type="select" label="Interval set rule" help="-isr,--interval_set_rule &amp;lt;interval_set_rule&amp;gt;">
194 <option value="UNION" selected="True">UNION</option>
195 <option value="INTERSECTION">INTERSECTION</option>
196 </param>
197
198 <conditional name="downsampling_type">
199 <param name="downsampling_type_selector" type="select" label="Type of reads downsampling to employ at a given locus" help="-dt,--downsampling_type &amp;lt;downsampling_type&amp;gt;">
200 <option value="NONE" selected="True">NONE</option>
201 <option value="ALL_READS">ALL_READS</option>
202 <option value="BY_SAMPLE">BY_SAMPLE</option>
203 </param>
204 <when value="NONE">
205 <!-- no more options here -->
206 </when>
207 <when value="ALL_READS">
208 <conditional name="downsample_to_type">
209 <param name="downsample_to_type_selector" type="select" label="Downsample method">
210 <option value="downsample_to_fraction" selected="True">Downsample by Fraction</option>
211 <option value="downsample_to_coverage">Downsample by Coverage</option>
212 </param>
213 <when value="downsample_to_fraction">
214 <param name="downsample_to_value" type="float" label="Fraction [0.0-1.0] of reads to downsample to" value="1" min="0" max="1" help="-dfrac,--downsample_to_fraction &amp;lt;downsample_to_fraction&amp;gt;"/>
215 </when>
216 <when value="downsample_to_coverage">
217 <param name="downsample_to_value" type="integer" label="Coverage to downsample to at any given locus" value="0" help="-dcov,--downsample_to_coverage &amp;lt;downsample_to_coverage&amp;gt;"/>
218 </when>
219 </conditional>
220 </when>
221 <when value="BY_SAMPLE">
222 <conditional name="downsample_to_type">
223 <param name="downsample_to_type_selector" type="select" label="Downsample method">
224 <option value="downsample_to_fraction" selected="True">Downsample by Fraction</option>
225 <option value="downsample_to_coverage">Downsample by Coverage</option>
226 </param>
227 <when value="downsample_to_fraction">
228 <param name="downsample_to_value" type="float" label="Fraction [0.0-1.0] of reads to downsample to" value="1" min="0" max="1" help="-dfrac,--downsample_to_fraction &amp;lt;downsample_to_fraction&amp;gt;"/>
229 </when>
230 <when value="downsample_to_coverage">
231 <param name="downsample_to_value" type="integer" label="Coverage to downsample to at any given locus" value="0" help="-dcov,--downsample_to_coverage &amp;lt;downsample_to_coverage&amp;gt;"/>
232 </when>
233 </conditional>
234 </when>
235 </conditional>
236 <param name="baq" type="select" label="Type of BAQ calculation to apply in the engine" help="-baq,--baq &amp;lt;baq&amp;gt;">
237 <option value="OFF" selected="True">OFF</option>
238 <option value="CALCULATE_AS_NECESSARY">CALCULATE_AS_NECESSARY</option>
239 <option value="RECALCULATE">RECALCULATE</option>
240 </param>
241 <param name="baq_gap_open_penalty" type="float" label="BAQ gap open penalty (Phred Scaled)" value="40" help="Default value is 40. 30 is perhaps better for whole genome call sets. -baqGOP,--baqGapOpenPenalty &amp;lt;baqGapOpenPenalty&amp;gt;" />
242 <param name="use_original_qualities" type="boolean" truevalue="--useOriginalQualities" falsevalue="" label="Use the original base quality scores from the OQ tag" help="-OQ,--useOriginalQualities" />
243 <param name="default_base_qualities" type="integer" label="Value to be used for all base quality scores, when some are missing" value="-1" help="-DBQ,--defaultBaseQualities &amp;lt;defaultBaseQualities&amp;gt;"/>
244 <param name="validation_strictness" type="select" label="How strict should we be with validation" help="-S,--validation_strictness &amp;lt;validation_strictness&amp;gt;">
245 <option value="STRICT" selected="True">STRICT</option>
246 <option value="LENIENT">LENIENT</option>
247 <option value="SILENT">SILENT</option>
248 <!-- <option value="DEFAULT_STRINGENCY">DEFAULT_STRINGENCY</option> listed in docs, but not valid value...-->
249 </param>
250 <param name="interval_merging" type="select" label="Interval merging rule" help="-im,--interval_merging &amp;lt;interval_merging&amp;gt;">
251 <option value="ALL" selected="True">ALL</option>
252 <option value="OVERLAPPING_ONLY">OVERLAPPING_ONLY</option>
253 </param>
254
255 <repeat name="read_group_black_list_repeat" title="Read group black list" help="-rgbl,--read_group_black_list &amp;lt;read_group_black_list&amp;gt;">
256 <conditional name="read_group_black_list_type">
257 <param name="read_group_black_list_type_selector" type="select" label="Type of reads read group black list">
258 <option value="file" selected="True">Filters in file</option>
259 <option value="text">Specify filters as a string</option>
260 </param>
261 <when value="file">
262 <param name="read_group_black_list" type="data" format="txt" label="Read group black list file" />
263 </when>
264 <when value="text">
265 <param name="read_group_black_list" type="text" value="tag:string" label="Read group black list tag:string" />
266 </when>
267 </conditional>
268 </repeat>
269
270 <param name="disable_experimental_low_memory_sharding" type="boolean" truevalue="--disable_experimental_low_memory_sharding" falsevalue="" label="Disable experimental low-memory sharding functionality." checked="False" help="--disable_experimental_low_memory_sharding"/>
271 <param name="non_deterministic_random_seed" type="boolean" truevalue="--nonDeterministicRandomSeed" falsevalue="" label="Makes the GATK behave non deterministically, that is, the random numbers generated will be different in every run" checked="False" help="-ndrs,--nonDeterministicRandomSeed"/>
272
273 </when>
274 </conditional>
275 </xml>
276 <xml name="analysis_type_conditional">
277 <conditional name="analysis_param_type">
278 <param name="analysis_param_type_selector" type="select" label="Basic or Advanced Analysis options">
279 <option value="basic" selected="True">Basic</option>
280 <option value="advanced">Advanced</option>
281 </param>
282 <when value="basic">
283 <!-- Do nothing here -->
284 </when>
285 <when value="advanced">
286 <yield />
287 </when>
288 </conditional>
289 </xml>
290 <xml name="reference_source_selector_param">
291 <param name="reference_source_selector" type="select" label="Choose the source for the reference list">
292 <option value="cached">Locally cached</option>
293 <option value="history">History</option>
294 </param>
295 </xml>
296 <token name="@CITATION_SECTION@">------
297
298 **Citation**
299
300 For the underlying tool, please cite `DePristo MA, Banks E, Poplin R, Garimella KV, Maguire JR, Hartl C, Philippakis AA, del Angel G, Rivas MA, Hanna M, McKenna A, Fennell TJ, Kernytsky AM, Sivachenko AY, Cibulskis K, Gabriel SB, Altshuler D, Daly MJ. A framework for variation discovery and genotyping using next-generation DNA sequencing data. Nat Genet. 2011 May;43(5):491-8. &lt;http://www.ncbi.nlm.nih.gov/pubmed/21478889&gt;`_
301
302 If you use this tool in Galaxy, please cite Blankenberg D, et al. *In preparation.*
303
304 </token>
305 </macros>