/tools/gatk/count_covariates.xml
XML | 292 lines | 262 code | 25 blank | 5 comment | 0 complexity | c01d6e8aa8fc5baa944405df7387629d MD5 | raw file
1<tool id="gatk_count_covariates" name="Count Covariates" version="0.0.5">
2 <description>on BAM files</description>
3 <requirements>
4 <requirement type="package" version="1.4">gatk</requirement>
5 <requirement type="package">samtools</requirement>
6 </requirements>
7 <macros>
8 <import>gatk_macros.xml</import>
9 </macros>
10 <command interpreter="python">gatk_wrapper.py
11 --max_jvm_heap_fraction "1"
12 --stdout "${output_log}"
13 -d "-I" "${reference_source.input_bam}" "${reference_source.input_bam.ext}" "gatk_input"
14 #if str( $reference_source.input_bam.metadata.bam_index ) != "None":
15 -d "" "${reference_source.input_bam.metadata.bam_index}" "bam_index" "gatk_input" ##hardcode galaxy ext type as bam_index
16 #end if
17 -p 'java
18 -jar "${GALAXY_DATA_INDEX_DIR}/shared/jars/gatk/GenomeAnalysisTK.jar"
19 -T "CountCovariates"
20 --num_threads 4 ##hard coded, for now
21 -et "NO_ET" ##ET no phone home
22 ##-log "${output_log}" ##don't use this to log to file, instead directly capture stdout
23 #if $reference_source.reference_source_selector != "history":
24 -R "${reference_source.ref_file.fields.path}"
25 #end if
26 --recal_file "${output_recal}"
27 ${standard_covs}
28 #if str( $covariates ) != "None":
29 #for $cov in str( $covariates ).split( ',' ):
30 -cov "${cov}"
31 #end for
32 #end if
33 '
34
35 #set $snp_dataset_provided = False
36 #set $rod_binding_names = dict()
37 #for $rod_binding in $rod_bind:
38 #if str( $rod_binding.rod_bind_type.rod_bind_type_selector ) == 'custom':
39 #set $rod_bind_name = $rod_binding.rod_bind_type.custom_rod_name
40 #else
41 #set $rod_bind_name = $rod_binding.rod_bind_type.rod_bind_type_selector
42 #end if
43 #if str( $rod_binding.rod_bind_type.rod_bind_type_selector ) == 'dbsnp':
44 #set $snp_dataset_provided = True
45 #end if
46 #set $rod_binding_names[$rod_bind_name] = $rod_binding_names.get( $rod_bind_name, -1 ) + 1
47 -d "--knownSites:${rod_bind_name},%(file_type)s" "${rod_binding.rod_bind_type.input_rod}" "${rod_binding.rod_bind_type.input_rod.ext}" "input_${rod_bind_name}_${rod_binding_names[$rod_bind_name]}"
48 #end for
49
50 #include source=$standard_gatk_options#
51
52 ##start analysis specific options
53 #if $analysis_param_type.analysis_param_type_selector == "advanced":
54 -p '
55 #if $analysis_param_type.default_read_group_type.default_read_group_type_selector == "set":
56 --default_read_group "${analysis_param_type.default_read_group_type.default_read_group}"
57 #end if
58 #if str( $analysis_param_type.default_platform ) != "default":
59 --default_platform "${analysis_param_type.default_platform}"
60 #end if
61 #if str( $analysis_param_type.force_read_group_type.force_read_group_type_selector ) == "set":
62 --force_read_group "${analysis_param_type.force_read_group_type.force_read_group}"
63 #end if
64 #if str( $analysis_param_type.force_platform ) != "default":
65 --force_platform "${analysis_param_type.force_platform}"
66 #end if
67 ${analysis_param_type.exception_if_no_tile}
68 #if str( $analysis_param_type.solid_options_type.solid_options_type_selector ) == "set":
69 #if str( $analysis_param_type.solid_options_type.solid_recal_mode ) != "default":
70 --solid_recal_mode "${analysis_param_type.solid_options_type.solid_recal_mode}"
71 #end if
72 #if str( $analysis_param_type.solid_options_type.solid_nocall_strategy ) != "default":
73 --solid_nocall_strategy "${analysis_param_type.solid_options_type.solid_nocall_strategy}"
74 #end if
75 #end if
76 --window_size_nqs "${analysis_param_type.window_size_nqs}"
77 --homopolymer_nback "${analysis_param_type.homopolymer_nback}"
78 '
79 #end if
80 #if not $snp_dataset_provided:
81 -p '--run_without_dbsnp_potentially_ruining_quality'
82 #end if
83 </command>
84 <inputs>
85 <conditional name="reference_source">
86 <expand macro="reference_source_selector_param" />
87 <when value="cached">
88 <param name="input_bam" type="data" format="bam" label="BAM file" help="-I,--input_file &lt;input_file&gt;">
89 <validator type="unspecified_build" />
90 <validator type="dataset_metadata_in_data_table" table_name="gatk_picard_indexes" metadata_name="dbkey" metadata_column="dbkey" message="Sequences are not currently available for the specified build." /> <!-- fixme!!! this needs to be a select -->
91 </param>
92 <param name="ref_file" type="select" label="Using reference genome" help="-R,--reference_sequence &lt;reference_sequence&gt;" >
93 <options from_data_table="gatk_picard_indexes">
94 <filter type="data_meta" key="dbkey" ref="input_bam" column="dbkey"/>
95 </options>
96 <validator type="no_options" message="A built-in reference genome is not available for the build associated with the selected input file"/>
97 </param>
98 </when>
99 <when value="history">
100 <param name="input_bam" type="data" format="bam" label="BAM file" help="-I,--input_file &lt;input_file&gt;" />
101 <param name="ref_file" type="data" format="fasta" label="Using reference file" help="-R,--reference_sequence &lt;reference_sequence&gt;">
102 <options>
103 <filter type="data_meta" key="dbkey" ref="input_bam" />
104 </options>
105 </param>
106 </when>
107 </conditional>
108 <param name="standard_covs" type="boolean" truevalue="--standard_covs" falsevalue="" label="Use the standard set of covariates in addition to the ones selected" help="-standard,--standard_covs" />
109 <param name="covariates" type="select" multiple="True" display="checkboxes" label="Covariates to be used in the recalibration" help="-cov,--covariate &lt;covariate&gt;" >
110 <!-- might we want to load the available covariates from an external configuration file, since additional ones can be added to local installs? -->
111 <option value="ReadGroupCovariate" />
112 <option value="QualityScoreCovariate" />
113 <option value="CycleCovariate" />
114 <option value="DinucCovariate" />
115 <!-- covariates below were pulled from list option -->
116 <option value="HomopolymerCovariate" />
117 <option value="GCContentCovariate" />
118 <option value="MappingQualityCovariate" />
119 <option value="MinimumNQSCovariate" />
120 <option value="PositionCovariate" />
121 <option value="PrimerRoundCovariate" />
122 <option value="TileCovariate" />
123 </param>
124
125 <repeat name="rod_bind" title="Binding for reference-ordered data" help="-knownSites,--knownSites &lt;knownSites&gt;">
126 <conditional name="rod_bind_type">
127 <param name="rod_bind_type_selector" type="select" label="Binding Type">
128 <option value="dbsnp" selected="True">dbSNP</option>
129 <option value="snps">SNPs</option>
130 <option value="indels">INDELs</option>
131 <option value="mask">Mask</option>
132 <option value="custom">Custom</option>
133 </param>
134 <when value="dbsnp">
135 <param name="input_rod" type="data" format="vcf,gatk_dbsnp,bed" label="ROD file" />
136 </when>
137 <when value="snps">
138 <param name="input_rod" type="data" format="vcf,gatk_dbsnp,bed" label="ROD file" />
139 </when>
140 <when value="indels">
141 <param name="input_rod" type="data" format="vcf,gatk_dbsnp,bed" label="ROD file" />
142 </when>
143 <when value="mask">
144 <param name="input_rod" type="data" format="vcf,gatk_dbsnp,bed" label="ROD file" />
145 </when>
146 <when value="custom">
147 <param name="custom_rod_name" type="text" value="Unknown" label="ROD Name"/>
148 <param name="input_rod" type="data" format="vcf,gatk_dbsnp,bed" label="ROD file" />
149 </when>
150 </conditional>
151 </repeat>
152
153 <expand macro="gatk_param_type_conditional" />
154
155 <expand macro="analysis_type_conditional">
156 <conditional name="default_read_group_type">
157 <param name="default_read_group_type_selector" type="select" label="Set default Read Group" help="--default_read_group">
158 <option value="default" selected="True">Don't Set</option>
159 <option value="set">Set</option>
160 </param>
161 <when value="default">
162 <!-- do nothing here -->
163 </when>
164 <when value="set">
165 <param name="default_read_group" type="text" value="Unknown" label="If a read has no read group then default to the provided String"/>
166 </when>
167 </conditional>
168 <param name="default_platform" type="select" label="Set default Platform" help="--default_platform">
169 <option value="default" selected="True">Don't Set</option>
170 <option value="illumina">illumina</option>
171 <option value="454">454</option>
172 <option value="solid">solid</option>
173 </param>
174 <conditional name="force_read_group_type">
175 <param name="force_read_group_type_selector" type="select" label="Force Read Group" help="--force_read_group">
176 <option value="default" selected="True">Don't Force</option>
177 <option value="set">Force</option>
178 </param>
179 <when value="default">
180 <!-- do nothing here -->
181 </when>
182 <when value="set">
183 <param name="force_read_group" type="text" value="Unknown" label="If provided, the read group ID of EVERY read will be forced to be the provided String."/>
184 </when>
185 </conditional>
186 <param name="force_platform" type="select" label="Force Platform" help="--force_platform">
187 <option value="default" selected="True">Don't Force</option>
188 <option value="illumina">illumina</option>
189 <option value="454">454</option>
190 <option value="solid">solid</option>
191 </param>
192 <param name="exception_if_no_tile" type="boolean" checked="False" truevalue="--exception_if_no_tile" falsevalue="" label="Throw an exception when no tile can be found" help="--exception_if_no_tile"/>
193 <conditional name="solid_options_type">
194 <param name="solid_options_type_selector" type="select" label="Set SOLiD specific options">
195 <option value="default" selected="True">Don't Set</option>
196 <option value="set">Set</option>
197 </param>
198 <when value="default">
199 <!-- do nothing here -->
200 </when>
201 <when value="set">
202 <param name="solid_recal_mode" type="select" label="How should we recalibrate solid bases in which the reference was inserted" help="-sMode,--solid_recal_mode &lt;solid_recal_mode&gt;">
203 <option value="default" selected="True">Don't set</option>
204 <option value="DO_NOTHING">DO_NOTHING</option>
205 <option value="SET_Q_ZERO">SET_Q_ZERO</option>
206 <option value="SET_Q_ZERO_BASE_N">SET_Q_ZERO_BASE_N</option>
207 <option value="REMOVE_REF_BIAS">REMOVE_REF_BIAS</option>
208 </param>
209 <param name="solid_nocall_strategy" type="select" label="Behavior of the recalibrator when it encounters no calls" help="-solid_nocall_strategy,--solid_nocall_strategy &lt;solid_nocall_strategy&gt;">
210 <option value="default" selected="True">Don't set</option>
211 <option value="THROW_EXCEPTION">THROW_EXCEPTION</option>
212 <option value="LEAVE_READ_UNRECALIBRATED">LEAVE_READ_UNRECALIBRATED</option>
213 <option value="PURGE_READ">PURGE_READ</option>
214 </param>
215 </when>
216 </conditional>
217 <param name="window_size_nqs" type="integer" value="5" label="Window size used by MinimumNQSCovariate" help="window_size_nqs"/>
218 <param name="homopolymer_nback" type="integer" value="7" label="number of previous bases to look at in HomopolymerCovariate" help="-nback,--homopolymer_nback &lt;homopolymer_nback&gt;" />
219 </expand>
220 </inputs>
221 <outputs>
222 <data format="csv" name="output_recal" label="${tool.name} on ${on_string} (Covariate File)" />
223 <data format="txt" name="output_log" label="${tool.name} on ${on_string} (log)" />
224 </outputs>
225 <tests>
226 <test>
227 <param name="reference_source_selector" value="history" />
228 <param name="ref_file" value="phiX.fasta" ftype="fasta" />
229 <param name="input_bam" value="gatk/gatk_indel_realigner/gatk_indel_realigner_out_1.bam" ftype="bam" />
230 <param name="rod_bind_type_selector" value="dbsnp" />
231 <param name="input_rod" value="gatk/fake_phiX_variant_locations.bed" ftype="bed" />
232 <param name="standard_covs" value="True" />
233 <param name="covariates" value="ReadGroupCovariate,HomopolymerCovariate,MinimumNQSCovariate,PositionCovariate" />
234 <param name="gatk_param_type_selector" value="basic" />
235 <param name="analysis_param_type_selector" value="basic" />
236 <output name="output_recal" file="gatk/gatk_count_covariates/gatk_count_covariates_out_1.csv" />
237 <output name="output_log" file="gatk/gatk_count_covariates/gatk_count_covariates_out_1.log.contains" compare="contains" />
238 </test>
239 </tests>
240 <help>
241.. class:: warningmark
242
243"This calculation is critically dependent on being able to skip over known variant sites. Please provide a dbSNP ROD or a VCF file containing known sites of genetic variation."
244However, if you do not provide this file, the '--run_without_dbsnp_potentially_ruining_quality' flag will be automatically used, and the command will be allowed to run.
245
246**What it does**
247
248This walker is designed to work as the first pass in a two-pass processing step. It does a by-locus traversal operating only at sites that are not in dbSNP. We assume that all reference mismatches we see are therefore errors and indicative of poor base quality. This walker generates tables based on various user-specified covariates (such as read group, reported quality score, cycle, and dinucleotide) Since there is a large amount of data one can then calculate an empirical probability of error given the particular covariates seen at this site, where p(error) = num mismatches / num observations The output file is a CSV list of (the several covariate values, num observations, num mismatches, empirical quality score) The first non-comment line of the output file gives the name of the covariates that were used for this calculation. Note: ReadGroupCovariate and QualityScoreCovariate are required covariates and will be added for the user regardless of whether or not they were specified Note: This walker is designed to be used in conjunction with TableRecalibrationWalker.
249
250For more information on base quality score recalibration using the GATK, see this `tool specific page <http://www.broadinstitute.org/gsa/wiki/index.php/Base_quality_score_recalibration>`_.
251
252To learn about best practices for variant detection using GATK, see this `overview <http://www.broadinstitute.org/gsa/wiki/index.php/Best_Practice_Variant_Detection_with_the_GATK_v3>`_.
253
254If you encounter errors, please view the `GATK FAQ <http://www.broadinstitute.org/gsa/wiki/index.php/Frequently_Asked_Questions>`_.
255
256------
257
258**Inputs**
259
260GenomeAnalysisTK: CountCovariates accepts an aligned BAM input file.
261
262
263**Outputs**
264
265The output is in CSV format.
266
267
268Go `here <http://www.broadinstitute.org/gsa/wiki/index.php/Input_files_for_the_GATK>`_ for details on GATK file formats.
269
270-------
271
272**Settings**::
273
274
275 default_read_group If a read has no read group then default to the provided String.
276 default_platform If a read has no platform then default to the provided String. Valid options are illumina, 454, and solid.
277 force_read_group If provided, the read group ID of EVERY read will be forced to be the provided String. This is useful to collapse all data into a single read group.
278 force_platform If provided, the platform of EVERY read will be forced to be the provided String. Valid options are illumina, 454, and solid.
279 window_size_nqs The window size used by MinimumNQSCovariate for its calculation
280 homopolymer_nback The number of previous bases to look at in HomopolymerCovariate
281 exception_if_no_tile If provided, TileCovariate will throw an exception when no tile can be found. The default behavior is to use tile = -1
282 solid_recal_mode How should we recalibrate solid bases in whichthe reference was inserted? Options = DO_NOTHING, SET_Q_ZERO, SET_Q_ZERO_BASE_N, or REMOVE_REF_BIAS (DO_NOTHING|SET_Q_ZERO|SET_Q_ZERO_BASE_N|REMOVE_REF_BIAS)
283 solid_nocall_strategy Defines the behavior of the recalibrator when it encounters no calls in the color space. Options = THROW_EXCEPTION, LEAVE_READ_UNRECALIBRATED, or PURGE_READ (THROW_EXCEPTION|LEAVE_READ_UNRECALIBRATED|PURGE_READ)
284 recal_file Filename for the input covariates table recalibration .csv file
285 out The output CSV file
286 recal_file Filename for the outputted covariates table recalibration file
287 standard_covs Use the standard set of covariates in addition to the ones listed using the -cov argument
288 run_without_dbsnp_potentially_ruining_quality If specified, allows the recalibrator to be used without a dbsnp rod. Very unsafe and for expert users only.
289
290@CITATION_SECTION@
291 </help>
292</tool>