Mercurial > repos > jjohnson > gatk2
annotate base_recalibrator.xml @ 29:c511aa6f93da draft
Temporarily use my own copy of samtools until cross dependency support is in release
| author | Jim Johnson <jj@umn.edu> |
|---|---|
| date | Tue, 19 Feb 2013 20:59:51 -0600 |
| parents | 6ef8eb568700 |
| children | b99c25b0ad4d |
| rev | line source |
|---|---|
|
18
7533db8dfb5b
Update tool_dependencies to GATK v 2.3
Jim Johnson <jj@umn.edu>
parents:
16
diff
changeset
|
1 <tool id="gatk2_base_recalibrator" name="Base Recalibrator" version="0.0.5"> |
| 0 | 2 <description>on BAM files</description> |
| 3 <requirements> | |
|
18
7533db8dfb5b
Update tool_dependencies to GATK v 2.3
Jim Johnson <jj@umn.edu>
parents:
16
diff
changeset
|
4 <requirement type="package" version="2.3">gatk</requirement> |
| 0 | 5 <requirement type="package" version="0.1.18">samtools</requirement> |
| 6 </requirements> | |
| 7 <command interpreter="python">gatk2_wrapper.py | |
| 8 --max_jvm_heap_fraction "1" | |
| 9 --stdout "${output_log}" | |
| 10 -d "-I" "${reference_source.input_bam}" "${reference_source.input_bam.ext}" "gatk_input" | |
| 11 #if str( $reference_source.input_bam.metadata.bam_index ) != "None": | |
| 12 -d "" "${reference_source.input_bam.metadata.bam_index}" "bam_index" "gatk_input" ##hardcode galaxy ext type as bam_index | |
| 13 #end if | |
| 14 -p 'java | |
| 15 -jar "\$GATK2_PATH/GenomeAnalysisTK.jar" | |
| 16 -T "BaseRecalibrator" | |
| 17 \$GATK2_SITE_OPTIONS | |
|
28
6ef8eb568700
Move GATK tool_dependency to a repository dependency, use 2 env vars: GATK2_NUM_THREADS and GATK2_NUM_CPU_THREADS for site threading values
Jim Johnson <jj@umn.edu>
parents:
24
diff
changeset
|
18 \$GATK2_CPU_THREADS |
| 0 | 19 ##--num_threads 4 ##hard coded, for now |
| 20 ##-et "NO_ET" -K "/data/galaxy/appList/GenomeAnalysisTK-2.0-36-gf5c1c1a/gatk2_key_file" ##ET no phone home | |
| 21 ##-log "${output_log}" ##don't use this to log to file, instead directly capture stdout | |
| 22 #if $reference_source.reference_source_selector != "history": | |
| 23 -R "${reference_source.ref_file.fields.path}" | |
| 24 #end if | |
|
24
6460f2ba6a60
Add BQSR and plot_pdf_file options to base_recalibrator.xml
Jim Johnson <jj@umn.edu>
parents:
23
diff
changeset
|
25 #if str($input_recal) != 'None': |
|
6460f2ba6a60
Add BQSR and plot_pdf_file options to base_recalibrator.xml
Jim Johnson <jj@umn.edu>
parents:
23
diff
changeset
|
26 --BQSR "${input_recal}" |
|
6460f2ba6a60
Add BQSR and plot_pdf_file options to base_recalibrator.xml
Jim Johnson <jj@umn.edu>
parents:
23
diff
changeset
|
27 #end if |
| 0 | 28 --out "${output_recal}" |
| 29 ${standard_covs} | |
| 30 #if str( $covariates ) != "None": | |
| 31 #for $cov in str( $covariates ).split( ',' ): | |
| 32 -cov "${cov}" | |
| 33 #end for | |
| 34 #end if | |
|
24
6460f2ba6a60
Add BQSR and plot_pdf_file options to base_recalibrator.xml
Jim Johnson <jj@umn.edu>
parents:
23
diff
changeset
|
35 #if $plot_pdf: |
|
6460f2ba6a60
Add BQSR and plot_pdf_file options to base_recalibrator.xml
Jim Johnson <jj@umn.edu>
parents:
23
diff
changeset
|
36 --plot_pdf_file $output_pdf |
|
6460f2ba6a60
Add BQSR and plot_pdf_file options to base_recalibrator.xml
Jim Johnson <jj@umn.edu>
parents:
23
diff
changeset
|
37 #end if |
| 0 | 38 ' |
| 39 | |
| 40 #set $snp_dataset_provided = False | |
| 41 #set $rod_binding_names = dict() | |
| 42 #for $rod_binding in $rod_bind: | |
| 43 #if str( $rod_binding.rod_bind_type.rod_bind_type_selector ) == 'custom': | |
| 44 #set $rod_bind_name = $rod_binding.rod_bind_type.custom_rod_name | |
| 45 #else | |
| 46 #set $rod_bind_name = $rod_binding.rod_bind_type.rod_bind_type_selector | |
| 47 #end if | |
| 48 #if str( $rod_binding.rod_bind_type.rod_bind_type_selector ) == 'dbsnp': | |
| 49 #set $snp_dataset_provided = True | |
| 50 #end if | |
| 51 #set $rod_binding_names[$rod_bind_name] = $rod_binding_names.get( $rod_bind_name, -1 ) + 1 | |
| 52 -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]}" | |
| 53 #end for | |
| 54 | |
| 55 ##start standard gatk options | |
| 56 #if $gatk_param_type.gatk_param_type_selector == "advanced": | |
| 57 #for $pedigree in $gatk_param_type.pedigree: | |
| 58 -p '--pedigree "${pedigree.pedigree_file}"' | |
| 59 #end for | |
| 60 #for $pedigree_string in $gatk_param_type.pedigree_string_repeat: | |
| 61 -p '--pedigreeString "${pedigree_string.pedigree_string}"' | |
| 62 #end for | |
| 63 -p '--pedigreeValidationType "${gatk_param_type.pedigree_validation_type}"' | |
| 64 #for $read_filter in $gatk_param_type.read_filter: | |
| 65 -p '--read_filter "${read_filter.read_filter_type.read_filter_type_selector}" | |
| 66 ###raise Exception( str( dir( $read_filter ) ) ) | |
| 67 #for $name, $param in $read_filter.read_filter_type.iteritems(): | |
| 68 #if $name not in [ "__current_case__", "read_filter_type_selector" ]: | |
| 69 #if hasattr( $param.input, 'truevalue' ): | |
| 70 ${param} | |
| 71 #else: | |
| 72 --${name} "${param}" | |
| 73 #end if | |
| 74 #end if | |
| 75 #end for | |
| 76 ' | |
| 77 #end for | |
| 78 #for $interval_count, $input_intervals in enumerate( $gatk_param_type.input_interval_repeat ): | |
| 79 -d "--intervals" "${input_intervals.input_intervals}" "${input_intervals.input_intervals.ext}" "input_intervals_${interval_count}" | |
| 80 #end for | |
| 81 | |
| 82 #for $interval_count, $input_intervals in enumerate( $gatk_param_type.input_exclude_interval_repeat ): | |
| 83 -d "--excludeIntervals" "${input_intervals.input_exclude_intervals}" "${input_intervals.input_exclude_intervals.ext}" "input_exlude_intervals_${interval_count}" | |
| 84 #end for | |
| 85 | |
| 86 -p '--interval_set_rule "${gatk_param_type.interval_set_rule}"' | |
| 87 | |
| 88 -p '--downsampling_type "${gatk_param_type.downsampling_type.downsampling_type_selector}"' | |
| 89 #if str( $gatk_param_type.downsampling_type.downsampling_type_selector ) != "NONE": | |
| 90 -p '--${gatk_param_type.downsampling_type.downsample_to_type.downsample_to_type_selector} "${gatk_param_type.downsampling_type.downsample_to_type.downsample_to_value}"' | |
| 91 #end if | |
| 92 -p ' | |
| 93 --baq "${gatk_param_type.baq}" | |
| 94 --baqGapOpenPenalty "${gatk_param_type.baq_gap_open_penalty}" | |
| 95 ${gatk_param_type.use_original_qualities} | |
| 96 --defaultBaseQualities "${gatk_param_type.default_base_qualities}" | |
| 97 --validation_strictness "${gatk_param_type.validation_strictness}" | |
| 98 --interval_merging "${gatk_param_type.interval_merging}" | |
| 99 ${gatk_param_type.disable_experimental_low_memory_sharding} | |
|
18
7533db8dfb5b
Update tool_dependencies to GATK v 2.3
Jim Johnson <jj@umn.edu>
parents:
16
diff
changeset
|
100 ${gatk_param_type.fix_misencoded_quality_scores} |
| 0 | 101 ${gatk_param_type.non_deterministic_random_seed} |
| 102 ' | |
| 103 #for $rg_black_list_count, $rg_black_list in enumerate( $gatk_param_type.read_group_black_list_repeat ): | |
| 104 #if $rg_black_list.read_group_black_list_type.read_group_black_list_type_selector == "file": | |
| 105 -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}" | |
| 106 #else | |
| 107 -p '--read_group_black_list "${rg_black_list.read_group_black_list_type.read_group_black_list}"' | |
| 108 #end if | |
| 109 #end for | |
| 110 #end if | |
| 111 | |
| 112 #if str( $reference_source.reference_source_selector ) == "history": | |
| 113 -d "-R" "${reference_source.ref_file}" "${reference_source.ref_file.ext}" "gatk_input" | |
| 114 #end if | |
| 115 ##end standard gatk options | |
| 116 | |
| 117 ##start analysis specific options | |
| 118 #if $analysis_param_type.analysis_param_type_selector == "advanced": | |
| 119 -p ' | |
| 120 #if $analysis_param_type.default_read_group_type.default_read_group_type_selector == "set": | |
| 121 --default_read_group "${analysis_param_type.default_read_group_type.default_read_group}" | |
| 122 #end if | |
| 123 #if str( $analysis_param_type.default_platform ) != "default": | |
| 124 --default_platform "${analysis_param_type.default_platform}" | |
| 125 #end if | |
| 126 #if str( $analysis_param_type.force_read_group_type.force_read_group_type_selector ) == "set": | |
| 127 --force_read_group "${analysis_param_type.force_read_group_type.force_read_group}" | |
| 128 #end if | |
| 129 #if str( $analysis_param_type.force_platform ) != "default": | |
| 130 --force_platform "${analysis_param_type.force_platform}" | |
| 131 #end if | |
| 132 ${analysis_param_type.exception_if_no_tile} | |
| 133 #if str( $analysis_param_type.solid_options_type.solid_options_type_selector ) == "set": | |
| 134 #if str( $analysis_param_type.solid_options_type.solid_recal_mode ) != "default": | |
| 135 --solid_recal_mode "${analysis_param_type.solid_options_type.solid_recal_mode}" | |
| 136 #end if | |
| 137 #if str( $analysis_param_type.solid_options_type.solid_nocall_strategy ) != "default": | |
| 138 --solid_nocall_strategy "${analysis_param_type.solid_options_type.solid_nocall_strategy}" | |
| 139 #end if | |
| 140 #end if | |
| 141 --window_size_nqs "${analysis_param_type.window_size_nqs}" | |
| 142 --homopolymer_nback "${analysis_param_type.homopolymer_nback}" | |
| 143 ' | |
| 144 #end if | |
| 145 #if not $snp_dataset_provided: | |
| 146 -p '--run_without_dbsnp_potentially_ruining_quality' | |
| 147 #end if | |
| 148 </command> | |
| 149 <inputs> | |
| 150 <conditional name="reference_source"> | |
| 151 <param name="reference_source_selector" type="select" label="Choose the source for the reference list"> | |
| 152 <option value="cached">Locally cached</option> | |
| 153 <option value="history">History</option> | |
| 154 </param> | |
| 155 <when value="cached"> | |
| 156 <param name="input_bam" type="data" format="bam" label="BAM file" help="-I,--input_file &lt;input_file&gt;"> | |
| 157 <validator type="unspecified_build" /> | |
| 158 <validator type="dataset_metadata_in_data_table" table_name="gatk2_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 --> | |
| 159 </param> | |
| 160 <param name="ref_file" type="select" label="Using reference genome" help="-R,--reference_sequence &lt;reference_sequence&gt;" > | |
| 161 <options from_data_table="gatk2_picard_indexes"> | |
| 162 <filter type="data_meta" key="dbkey" ref="input_bam" column="dbkey"/> | |
| 163 </options> | |
| 164 <validator type="no_options" message="A built-in reference genome is not available for the build associated with the selected input file"/> | |
| 165 </param> | |
| 166 </when> | |
| 167 <when value="history"> | |
| 168 <param name="input_bam" type="data" format="bam" label="BAM file" help="-I,--input_file &lt;input_file&gt;" /> | |
| 169 <param name="ref_file" type="data" format="fasta" label="Using reference file" help="-R,--reference_sequence &lt;reference_sequence&gt;"> | |
| 170 <options> | |
| 171 <filter type="data_meta" key="dbkey" ref="input_bam" /> | |
| 172 </options> | |
| 173 </param> | |
| 174 </when> | |
| 175 </conditional> | |
|
24
6460f2ba6a60
Add BQSR and plot_pdf_file options to base_recalibrator.xml
Jim Johnson <jj@umn.edu>
parents:
23
diff
changeset
|
176 <param name="input_recal" type="data" format="gatk_report" optional="true" label="Covariates table recalibration file" help="-BQSR,--BQSR &lt;recal_file&gt;" > |
|
6460f2ba6a60
Add BQSR and plot_pdf_file options to base_recalibrator.xml
Jim Johnson <jj@umn.edu>
parents:
23
diff
changeset
|
177 <help>The input covariates table file which enables on-the-fly base quality score recalibration. |
|
6460f2ba6a60
Add BQSR and plot_pdf_file options to base_recalibrator.xml
Jim Johnson <jj@umn.edu>
parents:
23
diff
changeset
|
178 Enables on-the-fly recalibrate of base qualities. The covariates tables are produced by the BaseQualityScoreRecalibrator tool. |
|
6460f2ba6a60
Add BQSR and plot_pdf_file options to base_recalibrator.xml
Jim Johnson <jj@umn.edu>
parents:
23
diff
changeset
|
179 Please be aware that one should only run recalibration with the covariates file created on the same input bam(s). |
|
6460f2ba6a60
Add BQSR and plot_pdf_file options to base_recalibrator.xml
Jim Johnson <jj@umn.edu>
parents:
23
diff
changeset
|
180 </help> |
|
6460f2ba6a60
Add BQSR and plot_pdf_file options to base_recalibrator.xml
Jim Johnson <jj@umn.edu>
parents:
23
diff
changeset
|
181 </param> |
|
21
6e641ee02851
Fix base_recalibrator.xml option: no_standard_covs
Jim Johnson <jj@umn.edu>
parents:
18
diff
changeset
|
182 <param name="standard_covs" type="boolean" truevalue="" falsevalue="--no_standard_covs" checked="false" label="Do not use the standard set of covariates in addition to the ones selected" help="--no_standard_covs/-noStandard" /> |
| 0 | 183 <param name="covariates" type="select" multiple="True" display="checkboxes" label="Covariates to be used in the recalibration" help="-cov,--covariate &lt;covariate&gt;" > |
| 184 <!-- might we want to load the available covariates from an external configuration file, since additional ones can be added to local installs? --> | |
| 185 <option value="ReadGroupCovariate" /> | |
| 186 <option value="QualityScoreCovariate" /> | |
| 187 <option value="CycleCovariate" /> | |
|
23
2f9bf8bf42b7
Replace covariate DinucCovariate with ContextCovariate
Jim Johnson <jj@umn.edu>
parents:
22
diff
changeset
|
188 <option value="ContextCovariate" /> |
| 0 | 189 <!-- covariates below were pulled from list option --> |
| 190 <option value="HomopolymerCovariate" /> | |
| 191 <option value="GCContentCovariate" /> | |
| 192 <option value="MappingQualityCovariate" /> | |
| 193 <option value="MinimumNQSCovariate" /> | |
| 194 <option value="PositionCovariate" /> | |
| 195 <option value="PrimerRoundCovariate" /> | |
| 196 <option value="TileCovariate" /> | |
| 197 </param> | |
| 198 | |
| 199 <repeat name="rod_bind" title="Binding for reference-ordered data" help="-knownSites,--knownSites &lt;knownSites&gt;"> | |
| 200 <conditional name="rod_bind_type"> | |
| 201 <param name="rod_bind_type_selector" type="select" label="Binding Type"> | |
| 202 <option value="dbsnp" selected="True">dbSNP</option> | |
| 203 <option value="snps">SNPs</option> | |
| 204 <option value="indels">INDELs</option> | |
| 205 <option value="mask">Mask</option> | |
| 206 <option value="custom">Custom</option> | |
| 207 </param> | |
| 208 <when value="dbsnp"> | |
| 209 <param name="input_rod" type="data" format="vcf,gatk_dbsnp,bed" label="ROD file" /> | |
| 210 </when> | |
| 211 <when value="snps"> | |
| 212 <param name="input_rod" type="data" format="vcf,gatk_dbsnp,bed" label="ROD file" /> | |
| 213 </when> | |
| 214 <when value="indels"> | |
| 215 <param name="input_rod" type="data" format="vcf,gatk_dbsnp,bed" label="ROD file" /> | |
| 216 </when> | |
| 217 <when value="mask"> | |
| 218 <param name="input_rod" type="data" format="vcf,gatk_dbsnp,bed" label="ROD file" /> | |
| 219 </when> | |
| 220 <when value="custom"> | |
| 221 <param name="custom_rod_name" type="text" value="Unknown" label="ROD Name"/> | |
| 222 <param name="input_rod" type="data" format="vcf,gatk_dbsnp,bed" label="ROD file" /> | |
| 223 </when> | |
| 224 </conditional> | |
| 225 </repeat> | |
|
24
6460f2ba6a60
Add BQSR and plot_pdf_file options to base_recalibrator.xml
Jim Johnson <jj@umn.edu>
parents:
23
diff
changeset
|
226 <param name="plot_pdf" type="boolean" truevalue="--plot_pdf_file" falsevalue="" checked="False" label="Output recalibration plots pdf"/> |
| 0 | 227 <conditional name="gatk_param_type"> |
| 228 <param name="gatk_param_type_selector" type="select" label="Basic or Advanced GATK options"> | |
| 229 <option value="basic" selected="True">Basic</option> | |
| 230 <option value="advanced">Advanced</option> | |
| 231 </param> | |
| 232 <when value="basic"> | |
| 233 <!-- Do nothing here --> | |
| 234 </when> | |
| 235 <when value="advanced"> | |
| 236 <repeat name="pedigree" title="Pedigree file" help="-ped,--pedigree &lt;pedigree&gt;"> | |
| 237 <param name="pedigree_file" type="data" format="txt" label="Pedigree files for samples"/> | |
| 238 </repeat> | |
| 239 <repeat name="pedigree_string_repeat" title="Pedigree string" help="-pedString,--pedigreeString &lt;pedigreeString&gt;"> | |
| 240 <param name="pedigree_string" type="text" value="" label="Pedigree string for samples"/> | |
| 241 </repeat> | |
| 242 <param name="pedigree_validation_type" type="select" label="How strict should we be in validating the pedigree information" help="-pedValidationType,--pedigreeValidationType &lt;pedigreeValidationType&gt;"> | |
| 243 <option value="STRICT" selected="True">STRICT</option> | |
| 244 <option value="SILENT">SILENT</option> | |
| 245 </param> | |
| 246 <repeat name="read_filter" title="Read Filter" help="-rf,--read_filter &lt;read_filter&gt;"> | |
| 247 <conditional name="read_filter_type"> | |
| 248 <param name="read_filter_type_selector" type="select" label="Read Filter Type"> | |
| 249 <option value="BadCigar">BadCigar</option> | |
| 250 <option value="BadMate">BadMate</option> | |
| 251 <option value="DuplicateRead">DuplicateRead</option> | |
| 252 <option value="FailsVendorQualityCheck">FailsVendorQualityCheck</option> | |
| 253 <option value="MalformedRead">MalformedRead</option> | |
| 254 <option value="MappingQuality">MappingQuality</option> | |
| 255 <option value="MappingQualityUnavailable">MappingQualityUnavailable</option> | |
| 256 <option value="MappingQualityZero">MappingQualityZero</option> | |
| 257 <option value="MateSameStrand">MateSameStrand</option> | |
| 258 <option value="MaxInsertSize">MaxInsertSize</option> | |
| 259 <option value="MaxReadLength" selected="True">MaxReadLength</option> | |
| 260 <option value="MissingReadGroup">MissingReadGroup</option> | |
| 261 <option value="NoOriginalQualityScores">NoOriginalQualityScores</option> | |
| 262 <option value="NotPrimaryAlignment">NotPrimaryAlignment</option> | |
| 263 <option value="Platform454">Platform454</option> | |
| 264 <option value="Platform">Platform</option> | |
| 265 <option value="PlatformUnit">PlatformUnit</option> | |
| 266 <option value="ReadGroupBlackList">ReadGroupBlackList</option> | |
| 267 <option value="ReadName">ReadName</option> | |
| 268 <option value="ReadStrand">ReadStrand</option> | |
| 269 <option value="ReassignMappingQuality">ReassignMappingQuality</option> | |
| 270 <option value="Sample">Sample</option> | |
| 271 <option value="SingleReadGroup">SingleReadGroup</option> | |
| 272 <option value="UnmappedRead">UnmappedRead</option> | |
| 273 </param> | |
| 274 <when value="BadCigar"> | |
| 275 <!-- no extra options --> | |
| 276 </when> | |
| 277 <when value="BadMate"> | |
| 278 <!-- no extra options --> | |
| 279 </when> | |
| 280 <when value="DuplicateRead"> | |
| 281 <!-- no extra options --> | |
| 282 </when> | |
| 283 <when value="FailsVendorQualityCheck"> | |
| 284 <!-- no extra options --> | |
| 285 </when> | |
| 286 <when value="MalformedRead"> | |
| 287 <!-- no extra options --> | |
| 288 </when> | |
| 289 <when value="MappingQuality"> | |
| 290 <param name="min_mapping_quality_score" type="integer" value="10" label="Minimum read mapping quality required to consider a read for calling"/> | |
| 291 </when> | |
| 292 <when value="MappingQualityUnavailable"> | |
| 293 <!-- no extra options --> | |
| 294 </when> | |
| 295 <when value="MappingQualityZero"> | |
| 296 <!-- no extra options --> | |
| 297 </when> | |
| 298 <when value="MateSameStrand"> | |
| 299 <!-- no extra options --> | |
| 300 </when> | |
| 301 <when value="MaxInsertSize"> | |
| 302 <param name="maxInsertSize" type="integer" value="1000000" label="Discard reads with insert size greater than the specified value"/> | |
| 303 </when> | |
| 304 <when value="MaxReadLength"> | |
| 305 <param name="maxReadLength" type="integer" value="76" label="Max Read Length"/> | |
| 306 </when> | |
| 307 <when value="MissingReadGroup"> | |
| 308 <!-- no extra options --> | |
| 309 </when> | |
| 310 <when value="NoOriginalQualityScores"> | |
| 311 <!-- no extra options --> | |
| 312 </when> | |
| 313 <when value="NotPrimaryAlignment"> | |
| 314 <!-- no extra options --> | |
| 315 </when> | |
| 316 <when value="Platform454"> | |
| 317 <!-- no extra options --> | |
| 318 </when> | |
| 319 <when value="Platform"> | |
| 320 <param name="PLFilterName" type="text" value="" label="Discard reads with RG:PL attribute containing this string"/> | |
| 321 </when> | |
| 322 <when value="PlatformUnit"> | |
| 323 <!-- no extra options --> | |
| 324 </when> | |
| 325 <when value="ReadGroupBlackList"> | |
| 326 <!-- no extra options --> | |
| 327 </when> | |
| 328 <when value="ReadName"> | |
| 329 <param name="readName" type="text" value="" label="Filter out all reads except those with this read name"/> | |
| 330 </when> | |
| 331 <when value="ReadStrand"> | |
| 332 <param name="filterPositive" type="boolean" truevalue="--filterPositive" falsevalue="" label="Discard reads on the forward strand"/> | |
| 333 </when> | |
| 334 <when value="ReassignMappingQuality"> | |
| 335 <param name="default_mapping_quality" type="integer" value="60" label="Default read mapping quality to assign to all reads"/> | |
| 336 </when> | |
| 337 <when value="Sample"> | |
| 338 <param name="sample_to_keep" type="text" value="" label="The name of the sample(s) to keep, filtering out all others"/> | |
| 339 </when> | |
| 340 <when value="SingleReadGroup"> | |
| 341 <param name="read_group_to_keep" type="integer" value="76" label="The name of the read group to keep, filtering out all others"/> | |
| 342 </when> | |
| 343 <when value="UnmappedRead"> | |
| 344 <!-- no extra options --> | |
| 345 </when> | |
| 346 </conditional> | |
| 347 </repeat> | |
| 348 <repeat name="input_interval_repeat" title="Operate on Genomic intervals" help="-L,--intervals &lt;intervals&gt;"> | |
| 349 <param name="input_intervals" type="data" format="bed,gatk_interval,picard_interval_list,vcf" label="Genomic intervals" /> | |
| 350 </repeat> | |
| 351 <repeat name="input_exclude_interval_repeat" title="Exclude Genomic intervals" help="-XL,--excludeIntervals &lt;excludeIntervals&gt;"> | |
| 352 <param name="input_exclude_intervals" type="data" format="bed,gatk_interval,picard_interval_list,vcf" label="Genomic intervals" /> | |
| 353 </repeat> | |
| 354 | |
| 355 <param name="interval_set_rule" type="select" label="Interval set rule" help="-isr,--interval_set_rule &lt;interval_set_rule&gt;"> | |
| 356 <option value="UNION" selected="True">UNION</option> | |
| 357 <option value="INTERSECTION">INTERSECTION</option> | |
| 358 </param> | |
| 359 | |
| 360 <conditional name="downsampling_type"> | |
| 361 <param name="downsampling_type_selector" type="select" label="Type of reads downsampling to employ at a given locus" help="-dt,--downsampling_type &lt;downsampling_type&gt;"> | |
| 362 <option value="NONE" selected="True">NONE</option> | |
| 363 <option value="ALL_READS">ALL_READS</option> | |
| 364 <option value="BY_SAMPLE">BY_SAMPLE</option> | |
| 365 </param> | |
| 366 <when value="NONE"> | |
| 367 <!-- no more options here --> | |
| 368 </when> | |
| 369 <when value="ALL_READS"> | |
| 370 <conditional name="downsample_to_type"> | |
| 371 <param name="downsample_to_type_selector" type="select" label="Downsample method"> | |
| 372 <option value="downsample_to_fraction" selected="True">Downsample by Fraction</option> | |
| 373 <option value="downsample_to_coverage">Downsample by Coverage</option> | |
| 374 </param> | |
| 375 <when value="downsample_to_fraction"> | |
| 376 <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 &lt;downsample_to_fraction&gt;"/> | |
| 377 </when> | |
| 378 <when value="downsample_to_coverage"> | |
| 379 <param name="downsample_to_value" type="integer" label="Coverage to downsample to at any given locus" value="0" help="-dcov,--downsample_to_coverage &lt;downsample_to_coverage&gt;"/> | |
| 380 </when> | |
| 381 </conditional> | |
| 382 </when> | |
| 383 <when value="BY_SAMPLE"> | |
| 384 <conditional name="downsample_to_type"> | |
| 385 <param name="downsample_to_type_selector" type="select" label="Downsample method"> | |
| 386 <option value="downsample_to_fraction" selected="True">Downsample by Fraction</option> | |
| 387 <option value="downsample_to_coverage">Downsample by Coverage</option> | |
| 388 </param> | |
| 389 <when value="downsample_to_fraction"> | |
| 390 <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 &lt;downsample_to_fraction&gt;"/> | |
| 391 </when> | |
| 392 <when value="downsample_to_coverage"> | |
| 393 <param name="downsample_to_value" type="integer" label="Coverage to downsample to at any given locus" value="0" help="-dcov,--downsample_to_coverage &lt;downsample_to_coverage&gt;"/> | |
| 394 </when> | |
| 395 </conditional> | |
| 396 </when> | |
| 397 </conditional> | |
| 398 <param name="baq" type="select" label="Type of BAQ calculation to apply in the engine" help="-baq,--baq &lt;baq&gt;"> | |
| 399 <option value="OFF" selected="True">OFF</option> | |
| 400 <option value="CALCULATE_AS_NECESSARY">CALCULATE_AS_NECESSARY</option> | |
| 401 <option value="RECALCULATE">RECALCULATE</option> | |
| 402 </param> | |
| 403 <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 &lt;baqGapOpenPenalty&gt;" /> | |
| 404 <param name="use_original_qualities" type="boolean" truevalue="--useOriginalQualities" falsevalue="" label="Use the original base quality scores from the OQ tag" help="-OQ,--useOriginalQualities" /> | |
| 405 <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 &lt;defaultBaseQualities&gt;"/> | |
| 406 <param name="validation_strictness" type="select" label="How strict should we be with validation" help="-S,--validation_strictness &lt;validation_strictness&gt;"> | |
| 407 <option value="STRICT" selected="True">STRICT</option> | |
| 408 <option value="LENIENT">LENIENT</option> | |
| 409 <option value="SILENT">SILENT</option> | |
| 410 <!-- <option value="DEFAULT_STRINGENCY">DEFAULT_STRINGENCY</option> listed in docs, but not valid value...--> | |
| 411 </param> | |
| 412 <param name="interval_merging" type="select" label="Interval merging rule" help="-im,--interval_merging &lt;interval_merging&gt;"> | |
| 413 <option value="ALL" selected="True">ALL</option> | |
| 414 <option value="OVERLAPPING_ONLY">OVERLAPPING_ONLY</option> | |
| 415 </param> | |
| 416 | |
| 417 <repeat name="read_group_black_list_repeat" title="Read group black list" help="-rgbl,--read_group_black_list &lt;read_group_black_list&gt;"> | |
| 418 <conditional name="read_group_black_list_type"> | |
| 419 <param name="read_group_black_list_type_selector" type="select" label="Type of reads read group black list"> | |
| 420 <option value="file" selected="True">Filters in file</option> | |
| 421 <option value="text">Specify filters as a string</option> | |
| 422 </param> | |
| 423 <when value="file"> | |
| 424 <param name="read_group_black_list" type="data" format="txt" label="Read group black list file" /> | |
| 425 </when> | |
| 426 <when value="text"> | |
| 427 <param name="read_group_black_list" type="text" value="tag:string" label="Read group black list tag:string" /> | |
| 428 </when> | |
| 429 </conditional> | |
| 430 </repeat> | |
| 431 | |
| 432 <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"/> | |
| 433 <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"/> | |
|
18
7533db8dfb5b
Update tool_dependencies to GATK v 2.3
Jim Johnson <jj@umn.edu>
parents:
16
diff
changeset
|
434 <param name="fix_misencoded_quality_scores" type="boolean" truevalue="--fix_misencoded_quality_scores" falsevalue="" label="Fix mis-encoded base quality scores. Q0 == ASCII 33 according to the SAM specification, whereas Illumina encoding starts at Q64. The idea here is simple: we just iterate over all reads and subtract 31 from every quality score." checked="False" help="-fixMisencodedQuals / --fix_misencoded_quality_scores"/> |
| 0 | 435 </when> |
| 436 </conditional> | |
| 437 | |
| 438 <conditional name="analysis_param_type"> | |
| 439 <param name="analysis_param_type_selector" type="select" label="Basic or Advanced Analysis options"> | |
| 440 <option value="basic" selected="True">Basic</option> | |
| 441 <option value="advanced">Advanced</option> | |
| 442 </param> | |
| 443 <when value="basic"> | |
| 444 <!-- Do nothing here --> | |
| 445 </when> | |
| 446 <when value="advanced"> | |
| 447 <conditional name="default_read_group_type"> | |
| 448 <param name="default_read_group_type_selector" type="select" label="Set default Read Group" help="--default_read_group"> | |
| 449 <option value="default" selected="True">Don't Set</option> | |
| 450 <option value="set">Set</option> | |
| 451 </param> | |
| 452 <when value="default"> | |
| 453 <!-- do nothing here --> | |
| 454 </when> | |
| 455 <when value="set"> | |
| 456 <param name="default_read_group" type="text" value="Unknown" label="If a read has no read group then default to the provided String"/> | |
| 457 </when> | |
| 458 </conditional> | |
| 459 <param name="default_platform" type="select" label="Set default Platform" help="--default_platform"> | |
| 460 <option value="default" selected="True">Don't Set</option> | |
| 461 <option value="illumina">illumina</option> | |
| 462 <option value="454">454</option> | |
| 463 <option value="solid">solid</option> | |
| 464 </param> | |
| 465 <conditional name="force_read_group_type"> | |
| 466 <param name="force_read_group_type_selector" type="select" label="Force Read Group" help="--force_read_group"> | |
| 467 <option value="default" selected="True">Don't Force</option> | |
| 468 <option value="set">Force</option> | |
| 469 </param> | |
| 470 <when value="default"> | |
| 471 <!-- do nothing here --> | |
| 472 </when> | |
| 473 <when value="set"> | |
| 474 <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."/> | |
| 475 </when> | |
| 476 </conditional> | |
| 477 <param name="force_platform" type="select" label="Force Platform" help="--force_platform"> | |
| 478 <option value="default" selected="True">Don't Force</option> | |
| 479 <option value="illumina">illumina</option> | |
| 480 <option value="454">454</option> | |
| 481 <option value="solid">solid</option> | |
| 482 </param> | |
| 483 <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"/> | |
| 484 <conditional name="solid_options_type"> | |
| 485 <param name="solid_options_type_selector" type="select" label="Set SOLiD specific options"> | |
| 486 <option value="default" selected="True">Don't Set</option> | |
| 487 <option value="set">Set</option> | |
| 488 </param> | |
| 489 <when value="default"> | |
| 490 <!-- do nothing here --> | |
| 491 </when> | |
| 492 <when value="set"> | |
| 493 <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;"> | |
| 494 <option value="default" selected="True">Don't set</option> | |
| 495 <option value="DO_NOTHING">DO_NOTHING</option> | |
| 496 <option value="SET_Q_ZERO">SET_Q_ZERO</option> | |
| 497 <option value="SET_Q_ZERO_BASE_N">SET_Q_ZERO_BASE_N</option> | |
| 498 <option value="REMOVE_REF_BIAS">REMOVE_REF_BIAS</option> | |
| 499 </param> | |
| 500 <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;"> | |
| 501 <option value="default" selected="True">Don't set</option> | |
| 502 <option value="THROW_EXCEPTION">THROW_EXCEPTION</option> | |
| 503 <option value="LEAVE_READ_UNRECALIBRATED">LEAVE_READ_UNRECALIBRATED</option> | |
| 504 <option value="PURGE_READ">PURGE_READ</option> | |
| 505 </param> | |
| 506 </when> | |
| 507 </conditional> | |
| 508 <param name="window_size_nqs" type="integer" value="5" label="Window size used by MinimumNQSCovariate" help="window_size_nqs"/> | |
| 509 <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;" /> | |
| 510 </when> | |
| 511 </conditional> | |
| 512 </inputs> | |
| 513 <outputs> | |
|
16
d56503a12975
base_recalibrator out_puts gatk_report
Jim Johnson <jj@umn.edu>
parents:
0
diff
changeset
|
514 <data format="gatk_report" name="output_recal" label="${tool.name} on ${on_string} (Covariate File)" /> |
| 0 | 515 <data format="txt" name="output_log" label="${tool.name} on ${on_string} (log)" /> |
|
24
6460f2ba6a60
Add BQSR and plot_pdf_file options to base_recalibrator.xml
Jim Johnson <jj@umn.edu>
parents:
23
diff
changeset
|
516 <data format="pdf" name="output_pdf" label="${tool.name} on ${on_string} (plot_pdf_file)"> |
|
6460f2ba6a60
Add BQSR and plot_pdf_file options to base_recalibrator.xml
Jim Johnson <jj@umn.edu>
parents:
23
diff
changeset
|
517 <filter>plot_pdf == True</filter> |
|
6460f2ba6a60
Add BQSR and plot_pdf_file options to base_recalibrator.xml
Jim Johnson <jj@umn.edu>
parents:
23
diff
changeset
|
518 </data> |
| 0 | 519 </outputs> |
| 520 <tests> | |
| 521 <test> | |
| 522 <param name="reference_source_selector" value="history" /> | |
| 523 <param name="ref_file" value="phiX.fasta" ftype="fasta" /> | |
| 524 <param name="input_bam" value="gatk/gatk_indel_realigner/gatk_indel_realigner_out_1.bam" ftype="bam" /> | |
| 525 <param name="rod_bind_type_selector" value="dbsnp" /> | |
| 526 <param name="input_rod" value="gatk/fake_phiX_variant_locations.bed" ftype="bed" /> | |
| 527 <param name="standard_covs" value="True" /> | |
| 528 <param name="covariates" value="ReadGroupCovariate,HomopolymerCovariate,MinimumNQSCovariate,PositionCovariate" /> | |
| 529 <param name="gatk_param_type_selector" value="basic" /> | |
| 530 <param name="analysis_param_type_selector" value="basic" /> | |
| 531 <output name="output_recal" file="gatk/gatk_count_covariates/gatk_count_covariates_out_1.csv" /> | |
| 532 <output name="output_log" file="gatk/gatk_count_covariates/gatk_count_covariates_out_1.log.contains" compare="contains" /> | |
| 533 </test> | |
| 534 </tests> | |
| 535 <help> | |
| 536 .. class:: warningmark | |
| 537 | |
| 538 "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." | |
| 539 However, 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. | |
| 540 | |
| 541 **What it does** | |
| 542 | |
| 543 This 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. | |
| 544 | |
| 545 For more information on base quality score recalibration using the GATK, see this `tool specific page <http://www.broadinstitute.org/gatk/gatkdocs/org_broadinstitute_sting_gatk_walkers_bqsr_BaseRecalibrator.html>`_. | |
| 546 | |
| 547 To learn about best practices for variant detection using GATK, see this `overview <http://www.broadinstitute.org/gatk/guide/topic?name=best-practices>`_. | |
| 548 | |
| 549 If you encounter errors, please view the `GATK FAQ <http://www.broadinstitute.org/gatk/guide/topic?name=faqs>`_. | |
| 550 | |
| 551 ------ | |
| 552 | |
| 553 **Inputs** | |
| 554 | |
| 555 GenomeAnalysisTK: BaseRecalibrator accepts an aligned BAM input file. | |
| 556 | |
| 557 | |
| 558 **Outputs** | |
| 559 | |
| 560 The output is in CSV format. | |
| 561 | |
| 562 | |
| 563 Go `here <http://www.broadinstitute.org/gatk/guide/topic?name=intro>`_ for details on GATK file formats. | |
| 564 | |
| 565 ------- | |
| 566 | |
| 567 **Settings**:: | |
| 568 | |
| 569 | |
| 570 default_read_group If a read has no read group then default to the provided String. | |
| 571 default_platform If a read has no platform then default to the provided String. Valid options are illumina, 454, and solid. | |
| 572 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. | |
| 573 force_platform If provided, the platform of EVERY read will be forced to be the provided String. Valid options are illumina, 454, and solid. | |
| 574 window_size_nqs The window size used by MinimumNQSCovariate for its calculation | |
| 575 homopolymer_nback The number of previous bases to look at in HomopolymerCovariate | |
| 576 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 | |
| 577 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) | |
| 578 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) | |
| 579 recal_file Filename for the input covariates table recalibration .csv file | |
| 580 out The output CSV file | |
| 581 standard_covs Use the standard set of covariates in addition to the ones listed using the -cov argument | |
| 582 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. | |
| 583 | |
| 584 ------ | |
| 585 | |
| 586 **Citation** | |
| 587 | |
| 588 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. <http://www.ncbi.nlm.nih.gov/pubmed/21478889>`_ | |
| 589 | |
| 590 Please also site `McKenna A, Hanna M, Banks E, Sivachenko A, Cibulskis K, Kernytsky A, Garimella K, Altshuler D, Gabriel S, Daly M, DePristo MA (2010). The Genome Analysis Toolkit: a MapReduce framework for analyzing next-generation DNA sequencing data. Genome Res. 20:1297-303. Epub 2010 Jul 19. <http://www.ncbi.nlm.nih.gov/pubmed/20644199>`_ | |
| 591 | |
| 592 If you use this tool in Galaxy, please cite `Blankenberg D, Von Kuster G, Coraor N, Ananda G, Lazarus R, Mangan M, Nekrutenko A, Taylor J. Galaxy: a web-based genome analysis tool for experimentalists. Curr Protoc Mol Biol. 2010 Jan;Chapter 19:Unit 19.10.1-21. <http://www.ncbi.nlm.nih.gov/pubmed/20069535>`_ | |
| 593 | |
| 594 </help> | |
| 595 </tool> |