Mercurial > repos > jjohnson > gatk2
annotate haplotype_caller.xml @ 37:dd9f8ea2b718 draft
unified_genotyper - indelGap penalty param need to be integer values
| author | Jim Johnson <jj@umn.edu> |
|---|---|
| date | Fri, 01 Mar 2013 12:43:41 -0600 |
| parents | 14d47237bb0a |
| children |
| rev | line source |
|---|---|
| 34 | 1 <tool id="gatk2_haplotype_caller" name="Haplotype Caller" version="0.0.7"> |
| 11 | 2 <description>Call SNPs and indels simultaneously via local de-novo assembly of haplotypes in an active region</description> |
| 3 <requirements> | |
|
18
7533db8dfb5b
Update tool_dependencies to GATK v 2.3
Jim Johnson <jj@umn.edu>
parents:
17
diff
changeset
|
4 <requirement type="package" version="2.3">gatk</requirement> |
| 11 | 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 "HaplotypeCaller" | |
| 17 -o "${output_vcf}" | |
| 18 ## \$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:
18
diff
changeset
|
19 ## \$GATK2_NUM_THREADS |
| 11 | 20 ##-et "NO_ET" -K "/data/galaxy/appList/GenomeAnalysisTK-2.0-36-gf5c1c1a/gatk2_key_file" ##ET no phone home |
| 21 ##--num_threads 4 ##not supported yet | |
| 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 #if str($input_recal) != 'None': | |
| 27 --BQSR "${input_recal}" | |
| 28 #end if | |
| 29 ' | |
| 30 ##start standard gatk options | |
| 31 #if $gatk_param_type.gatk_param_type_selector == "advanced": | |
| 32 #for $pedigree in $gatk_param_type.pedigree: | |
| 33 -p '--pedigree "${pedigree.pedigree_file}"' | |
| 34 #end for | |
| 35 #for $pedigree_string in $gatk_param_type.pedigree_string_repeat: | |
| 36 -p '--pedigreeString "${pedigree_string.pedigree_string}"' | |
| 37 #end for | |
| 38 -p '--pedigreeValidationType "${gatk_param_type.pedigree_validation_type}"' | |
| 35 | 39 #set default_read_filters = ['DuplicateRead','FailsVendorQualityCheck','NotPrimaryAlignment','MalformedRead','UnmappedRead'] |
| 11 | 40 #for $read_filter in $gatk_param_type.read_filter: |
| 35 | 41 -p ' |
| 42 #if $read_filter.read_filter_type.read_filter_type_selector not in $default_read_filters: | |
| 43 --read_filter "${read_filter.read_filter_type.read_filter_type_selector}" | |
| 36 | 44 #end if |
| 11 | 45 ###raise Exception( str( dir( $read_filter ) ) ) |
| 46 #for $name, $param in $read_filter.read_filter_type.iteritems(): | |
| 47 #if $name not in [ "__current_case__", "read_filter_type_selector" ]: | |
| 48 #if hasattr( $param.input, 'truevalue' ): | |
| 49 ${param} | |
| 50 #else: | |
| 51 --${name} "${param}" | |
| 52 #end if | |
| 53 #end if | |
| 54 #end for | |
| 55 ' | |
| 56 #end for | |
| 57 #for $interval_count, $input_intervals in enumerate( $gatk_param_type.input_interval_repeat ): | |
| 58 -d "--intervals" "${input_intervals.input_intervals}" "${input_intervals.input_intervals.ext}" "input_intervals_${interval_count}" | |
| 59 #end for | |
| 60 | |
| 61 #for $interval_count, $input_intervals in enumerate( $gatk_param_type.input_exclude_interval_repeat ): | |
| 62 -d "--excludeIntervals" "${input_intervals.input_exclude_intervals}" "${input_intervals.input_exclude_intervals.ext}" "input_exlude_intervals_${interval_count}" | |
| 63 #end for | |
| 64 | |
| 65 -p '--interval_set_rule "${gatk_param_type.interval_set_rule}"' | |
| 66 | |
| 67 -p '--downsampling_type "${gatk_param_type.downsampling_type.downsampling_type_selector}"' | |
| 68 #if str( $gatk_param_type.downsampling_type.downsampling_type_selector ) != "NONE": | |
| 69 -p '--${gatk_param_type.downsampling_type.downsample_to_type.downsample_to_type_selector} "${gatk_param_type.downsampling_type.downsample_to_type.downsample_to_value}"' | |
| 70 #end if | |
| 71 -p ' | |
| 72 --baq "${gatk_param_type.baq}" | |
| 73 --baqGapOpenPenalty "${gatk_param_type.baq_gap_open_penalty}" | |
| 74 ${gatk_param_type.use_original_qualities} | |
| 75 --defaultBaseQualities "${gatk_param_type.default_base_qualities}" | |
| 76 --validation_strictness "${gatk_param_type.validation_strictness}" | |
| 77 --interval_merging "${gatk_param_type.interval_merging}" | |
|
18
7533db8dfb5b
Update tool_dependencies to GATK v 2.3
Jim Johnson <jj@umn.edu>
parents:
17
diff
changeset
|
78 ${gatk_param_type.fix_misencoded_quality_scores} |
| 11 | 79 ${gatk_param_type.non_deterministic_random_seed} |
| 80 ' | |
| 81 #for $rg_black_list_count, $rg_black_list in enumerate( $gatk_param_type.read_group_black_list_repeat ): | |
| 82 #if $rg_black_list.read_group_black_list_type.read_group_black_list_type_selector == "file": | |
| 83 -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}" | |
| 84 #else | |
| 85 -p '--read_group_black_list "${rg_black_list.read_group_black_list_type.read_group_black_list}"' | |
| 86 #end if | |
| 87 #end for | |
| 88 #end if | |
| 89 | |
| 90 #if str( $reference_source.reference_source_selector ) == "history": | |
| 91 -d "-R" "${reference_source.ref_file}" "${reference_source.ref_file.ext}" "gatk_input" | |
| 92 #end if | |
| 93 ##end standard gatk options | |
| 94 | |
| 95 ##start analysis specific options | |
| 96 #if $analysis_param_type.analysis_param_type_selector == "advanced": | |
| 97 -p ' | |
| 17 | 98 #if $analysis_param_type.p_nonref_model.__str__ != "None" and len($analysis_param_type.p_nonref_model.__str__) > 0: |
| 99 --p_nonref_model $analysis_param_type.p_nonref_model | |
| 100 #end if | |
| 101 #if $analysis_param_type.heterozygosity.__str__.strip() != '': | |
| 102 --heterozygosity $analysis_param_type.heterozygosity | |
| 103 #end if | |
| 104 --genotyping_mode "${analysis_param_type.genotyping_mode_type.genotyping_mode}" | |
| 105 #if str( $analysis_param_type.genotyping_mode_type.genotyping_mode ) == 'GENOTYPE_GIVEN_ALLELES': | |
| 106 --alleles "${analysis_param_type.genotyping_mode_type.input_alleles_rod}" | |
| 107 #end if | |
| 108 #if $analysis_param_type.output_mode.__str__ != "None" and len($analysis_param_type.output_mode.__str__) > 0: | |
| 109 --output_mode $analysis_param_type.output_mode | |
| 110 #end if | |
| 111 | |
| 11 | 112 ## files |
| 113 #if str($analysis_param_type.activeRegionIn) != 'None': | |
| 114 --activeRegionIn "$analysis_param_type.activeRegionIn" | |
| 115 #end if | |
| 116 #if str($analysis_param_type.comp) != 'None': | |
| 117 --comp "$analysis_param_type.comp" | |
| 118 #end if | |
| 119 #if str($analysis_param_type.dbsnp) != 'None': | |
| 120 --dbsnp "$analysis_param_type.dbsnp" | |
| 121 #end if | |
| 17 | 122 ## |
| 123 #if str( $analysis_param_type.annotation ) != "None": | |
| 124 #for $annotation in str( $analysis_param_type.annotation.fields.gatk_value ).split( ','): | |
| 125 --annotation "${annotation}" | |
| 126 #end for | |
| 11 | 127 #end if |
| 17 | 128 #for $additional_annotation in $analysis_param_type.additional_annotations: |
| 129 --annotation "${additional_annotation.additional_annotation_name}" | |
| 130 #end for | |
| 131 #if str( $analysis_param_type.group ) != "None": | |
| 132 #for $group in str( $analysis_param_type.group ).split( ','): | |
| 133 --group "${group}" | |
| 134 #end for | |
| 11 | 135 #end if |
| 17 | 136 #if str( $analysis_param_type.exclude_annotations ) != "None": |
| 137 #for $annotation in str( $analysis_param_type.exclude_annotations.fields.gatk_value ).split( ','): | |
| 138 --excludeAnnotation "${annotation}" | |
| 139 #end for | |
| 11 | 140 #end if |
| 17 | 141 |
| 11 | 142 ## value setings |
| 143 #if $analysis_param_type.contamination_fraction_to_filter.__str__.strip() != '': | |
| 144 --contamination_fraction_to_filter $analysis_param_type.contamination_fraction_to_filter | |
| 145 #end if | |
| 146 #if $analysis_param_type.downsampleRegion.__str__.strip() != '': | |
| 147 --downsampleRegion $analysis_param_type.downsampleRegion | |
| 148 #end if | |
| 149 #if $analysis_param_type.minPruning.__str__.strip() != '': | |
| 150 --minPruning $analysis_param_type.minPruning | |
| 151 #end if | |
| 152 #if $analysis_param_type.standard_min_confidence_threshold_for_calling.__str__.strip() != '': | |
| 153 --standard_min_confidence_threshold_for_calling $analysis_param_type.standard_min_confidence_threshold_for_calling | |
| 154 #end if | |
| 155 #if $analysis_param_type.standard_min_confidence_threshold_for_emitting.__str__.strip() != '': | |
| 156 --standard_min_confidence_threshold_for_emitting $analysis_param_type.standard_min_confidence_threshold_for_emitting | |
| 157 #end if | |
| 158 #if $analysis_param_type.gcpHMM.__str__.strip() != '': | |
| 159 --gcpHMM $analysis_param_type.gcpHMM | |
| 160 #end if | |
| 161 #if $analysis_param_type.max_alternate_alleles.__str__.strip() != '': | |
| 162 --max_alternate_alleles $analysis_param_type.max_alternate_alleles | |
| 163 #end if | |
| 164 ## mode selections | |
| 165 #if $analysis_param_type.genotyping_mode.__str__ != "None" and len($analysis_param_type.genotyping_mode.__str__) > 0: | |
| 166 --genotyping_mode $analysis_param_type.genotyping_mode | |
| 167 #end if | |
| 168 #if $analysis_param_type.pair_hmm_implementation.__str__ != "None" and len($analysis_param_type.pair_hmm_implementation.__str__) > 0: | |
| 169 --pair_hmm_implementation $analysis_param_type.pair_hmm_implementation | |
| 170 #end if | |
| 171 ## optional outputs | |
| 172 #if $analysis_param_type.activeRegionOut: | |
| 173 --activeRegionOut $active_region_out | |
| 174 #end if | |
| 175 #if $analysis_param_type.graphOutput: | |
| 176 --graphOutput $graph_out | |
| 177 #end if | |
| 178 ## flags | |
| 179 $analysis_param_type.useAllelesTrigger | |
| 180 $analysis_param_type.fullHaplotype | |
| 181 $analysis_param_type.genotypeFullActiveRegion | |
| 182 $analysis_param_type.debug | |
| 183 ' | |
| 184 #end if | |
| 185 </command> | |
| 186 <inputs> | |
| 17 | 187 <param name="input_recal" type="data" format="gatk_report" optional="true" label="Covariates table recalibration file" help="-BQSR,--BQSR &lt;recal_file&gt;" > |
| 11 | 188 <help>The input covariates table file which enables on-the-fly base quality score recalibration. |
| 189 Enables on-the-fly recalibrate of base qualities. The covariates tables are produced by the BaseQualityScoreRecalibrator tool. | |
| 190 Please be aware that one should only run recalibration with the covariates file created on the same input bam(s). | |
| 191 </help> | |
| 192 </param> | |
| 193 <conditional name="reference_source"> | |
| 194 <param name="reference_source_selector" type="select" label="Choose the source for the reference list"> | |
| 195 <option value="cached">Locally cached</option> | |
| 196 <option value="history">History</option> | |
| 197 </param> | |
| 198 <when value="cached"> | |
| 199 <param name="input_bam" type="data" format="bam" label="BAM file" help="-I,--input_file &lt;input_file&gt;"> | |
| 200 <validator type="unspecified_build" /> | |
| 201 <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 --> | |
| 202 </param> | |
| 203 <param name="ref_file" type="select" label="Using reference genome" help="-R,--reference_sequence &lt;reference_sequence&gt;" > | |
| 204 <options from_data_table="gatk2_picard_indexes"> | |
| 205 <filter type="data_meta" key="dbkey" ref="input_bam" column="dbkey"/> | |
| 206 </options> | |
| 207 <validator type="no_options" message="A built-in reference genome is not available for the build associated with the selected input file"/> | |
| 208 </param> | |
| 209 </when> | |
| 210 <when value="history"> | |
| 211 <param name="input_bam" type="data" format="bam" label="BAM file" help="-I,--input_file &lt;input_file&gt;" /> | |
| 212 <param name="ref_file" type="data" format="fasta" label="Using reference file" help="-R,--reference_sequence &lt;reference_sequence&gt;"> | |
| 213 <options> | |
| 214 <filter type="data_meta" key="dbkey" ref="input_bam" /> | |
| 215 </options> | |
| 216 </param> | |
| 217 </when> | |
| 218 </conditional> | |
| 219 | |
| 220 <conditional name="gatk_param_type"> | |
| 221 <param name="gatk_param_type_selector" type="select" label="Basic or Advanced GATK options"> | |
| 222 <option value="basic" selected="True">Basic</option> | |
| 223 <option value="advanced">Advanced</option> | |
| 224 </param> | |
| 225 <when value="basic"> | |
| 226 <!-- Do nothing here --> | |
| 227 </when> | |
| 228 <when value="advanced"> | |
| 229 <repeat name="pedigree" title="Pedigree file" help="-ped,--pedigree &lt;pedigree&gt;"> | |
| 230 <param name="pedigree_file" type="data" format="txt" label="Pedigree files for samples"/> | |
| 231 </repeat> | |
| 232 <repeat name="pedigree_string_repeat" title="Pedigree string" help="-pedString,--pedigreeString &lt;pedigreeString&gt;"> | |
| 233 <param name="pedigree_string" type="text" value="" label="Pedigree string for samples"/> | |
| 234 </repeat> | |
| 235 <param name="pedigree_validation_type" type="select" label="How strict should we be in validating the pedigree information" help="-pedValidationType,--pedigreeValidationType &lt;pedigreeValidationType&gt;"> | |
| 236 <option value="STRICT" selected="True">STRICT</option> | |
| 237 <option value="SILENT">SILENT</option> | |
| 238 </param> | |
| 239 <repeat name="read_filter" title="Read Filter" help="-rf,--read_filter &lt;read_filter&gt;"> | |
| 240 <conditional name="read_filter_type"> | |
| 241 <param name="read_filter_type_selector" type="select" label="Read Filter Type"> | |
| 242 <option value="BadCigar">BadCigar</option> | |
| 243 <option value="BadMate">BadMate</option> | |
| 244 <option value="DuplicateRead">DuplicateRead</option> | |
| 245 <option value="FailsVendorQualityCheck">FailsVendorQualityCheck</option> | |
| 246 <option value="MalformedRead">MalformedRead</option> | |
| 247 <option value="MappingQuality">MappingQuality</option> | |
| 248 <option value="MappingQualityUnavailable">MappingQualityUnavailable</option> | |
| 249 <option value="MappingQualityZero">MappingQualityZero</option> | |
| 250 <option value="MateSameStrand">MateSameStrand</option> | |
| 251 <option value="MaxInsertSize">MaxInsertSize</option> | |
| 252 <option value="MaxReadLength" selected="True">MaxReadLength</option> | |
| 253 <option value="MissingReadGroup">MissingReadGroup</option> | |
| 254 <option value="NoOriginalQualityScores">NoOriginalQualityScores</option> | |
| 255 <option value="NotPrimaryAlignment">NotPrimaryAlignment</option> | |
| 256 <option value="Platform454">Platform454</option> | |
| 257 <option value="Platform">Platform</option> | |
| 258 <option value="PlatformUnit">PlatformUnit</option> | |
| 259 <option value="ReadGroupBlackList">ReadGroupBlackList</option> | |
| 260 <option value="ReadName">ReadName</option> | |
| 261 <option value="ReadStrand">ReadStrand</option> | |
| 262 <option value="ReassignMappingQuality">ReassignMappingQuality</option> | |
| 263 <option value="Sample">Sample</option> | |
| 264 <option value="SingleReadGroup">SingleReadGroup</option> | |
| 265 <option value="UnmappedRead">UnmappedRead</option> | |
| 266 </param> | |
| 267 <when value="BadCigar"> | |
| 268 <!-- no extra options --> | |
| 269 </when> | |
| 270 <when value="BadMate"> | |
| 271 <!-- no extra options --> | |
| 272 </when> | |
| 273 <when value="DuplicateRead"> | |
| 274 <!-- no extra options --> | |
| 275 </when> | |
| 276 <when value="FailsVendorQualityCheck"> | |
| 277 <!-- no extra options --> | |
| 278 </when> | |
| 279 <when value="MalformedRead"> | |
| 35 | 280 <param name="filter_mismatching_base_and_quals" type="boolean" truevalue="--filter_mismatching_base_and_quals" falsevalue="" checked="false" label="filter out the reads with mismatching number of bases and base qualities" help="filter out the mismatch reads instead of quitting with an error"/> |
| 11 | 281 </when> |
| 282 <when value="MappingQuality"> | |
| 283 <param name="min_mapping_quality_score" type="integer" value="10" label="Minimum read mapping quality required to consider a read for calling"/> | |
| 284 </when> | |
| 285 <when value="MappingQualityUnavailable"> | |
| 286 <!-- no extra options --> | |
| 287 </when> | |
| 288 <when value="MappingQualityZero"> | |
| 289 <!-- no extra options --> | |
| 290 </when> | |
| 291 <when value="MateSameStrand"> | |
| 292 <!-- no extra options --> | |
| 293 </when> | |
| 294 <when value="MaxInsertSize"> | |
| 295 <param name="maxInsertSize" type="integer" value="1000000" label="Discard reads with insert size greater than the specified value"/> | |
| 296 </when> | |
| 297 <when value="MaxReadLength"> | |
| 298 <param name="maxReadLength" type="integer" value="76" label="Max Read Length"/> | |
| 299 </when> | |
| 300 <when value="MissingReadGroup"> | |
| 301 <!-- no extra options --> | |
| 302 </when> | |
| 303 <when value="NoOriginalQualityScores"> | |
| 304 <!-- no extra options --> | |
| 305 </when> | |
| 306 <when value="NotPrimaryAlignment"> | |
| 307 <!-- no extra options --> | |
| 308 </when> | |
| 309 <when value="Platform454"> | |
| 310 <!-- no extra options --> | |
| 311 </when> | |
| 312 <when value="Platform"> | |
| 313 <param name="PLFilterName" type="text" value="" label="Discard reads with RG:PL attribute containing this string"/> | |
| 314 </when> | |
| 315 <when value="PlatformUnit"> | |
| 316 <!-- no extra options --> | |
| 317 </when> | |
| 318 <when value="ReadGroupBlackList"> | |
| 319 <!-- no extra options --> | |
| 320 </when> | |
| 321 <when value="ReadName"> | |
| 322 <param name="readName" type="text" value="" label="Filter out all reads except those with this read name"/> | |
| 323 </when> | |
| 324 <when value="ReadStrand"> | |
| 325 <param name="filterPositive" type="boolean" truevalue="--filterPositive" falsevalue="" label="Discard reads on the forward strand"/> | |
| 326 </when> | |
| 327 <when value="ReassignMappingQuality"> | |
| 328 <param name="default_mapping_quality" type="integer" value="60" label="Default read mapping quality to assign to all reads"/> | |
| 329 </when> | |
| 330 <when value="Sample"> | |
| 331 <param name="sample_to_keep" type="text" value="" label="The name of the sample(s) to keep, filtering out all others"/> | |
| 332 </when> | |
| 333 <when value="SingleReadGroup"> | |
| 334 <param name="read_group_to_keep" type="integer" value="76" label="The name of the read group to keep, filtering out all others"/> | |
| 335 </when> | |
| 336 <when value="UnmappedRead"> | |
| 337 <!-- no extra options --> | |
| 338 </when> | |
| 339 </conditional> | |
| 340 </repeat> | |
| 341 <repeat name="input_interval_repeat" title="Operate on Genomic intervals" help="-L,--intervals &lt;intervals&gt;"> | |
| 342 <param name="input_intervals" type="data" format="bed,gatk_interval,picard_interval_list,vcf" label="Genomic intervals" /> | |
| 343 </repeat> | |
| 344 <repeat name="input_exclude_interval_repeat" title="Exclude Genomic intervals" help="-XL,--excludeIntervals &lt;excludeIntervals&gt;"> | |
| 345 <param name="input_exclude_intervals" type="data" format="bed,gatk_interval,picard_interval_list,vcf" label="Genomic intervals" /> | |
| 346 </repeat> | |
| 347 | |
| 348 <param name="interval_set_rule" type="select" label="Interval set rule" help="-isr,--interval_set_rule &lt;interval_set_rule&gt;"> | |
| 349 <option value="UNION" selected="True">UNION</option> | |
| 350 <option value="INTERSECTION">INTERSECTION</option> | |
| 351 </param> | |
| 352 | |
| 353 <conditional name="downsampling_type"> | |
| 354 <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;"> | |
| 355 <option value="NONE" selected="True">NONE</option> | |
| 356 <option value="ALL_READS">ALL_READS</option> | |
| 357 <option value="BY_SAMPLE">BY_SAMPLE</option> | |
| 358 </param> | |
| 359 <when value="NONE"> | |
| 360 <!-- no more options here --> | |
| 361 </when> | |
| 362 <when value="ALL_READS"> | |
| 363 <conditional name="downsample_to_type"> | |
| 364 <param name="downsample_to_type_selector" type="select" label="Downsample method"> | |
| 365 <option value="downsample_to_fraction" selected="True">Downsample by Fraction</option> | |
| 366 <option value="downsample_to_coverage">Downsample by Coverage</option> | |
| 367 </param> | |
| 368 <when value="downsample_to_fraction"> | |
| 369 <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;"/> | |
| 370 </when> | |
| 371 <when value="downsample_to_coverage"> | |
| 372 <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;"/> | |
| 373 </when> | |
| 374 </conditional> | |
| 375 </when> | |
| 376 <when value="BY_SAMPLE"> | |
| 377 <conditional name="downsample_to_type"> | |
| 378 <param name="downsample_to_type_selector" type="select" label="Downsample method"> | |
| 379 <option value="downsample_to_fraction" selected="True">Downsample by Fraction</option> | |
| 380 <option value="downsample_to_coverage">Downsample by Coverage</option> | |
| 381 </param> | |
| 382 <when value="downsample_to_fraction"> | |
| 383 <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;"/> | |
| 384 </when> | |
| 385 <when value="downsample_to_coverage"> | |
| 386 <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;"/> | |
| 387 </when> | |
| 388 </conditional> | |
| 389 </when> | |
| 390 </conditional> | |
| 391 <param name="baq" type="select" label="Type of BAQ calculation to apply in the engine" help="-baq,--baq &lt;baq&gt;"> | |
| 392 <option value="OFF" selected="True">OFF</option> | |
| 393 <option value="CALCULATE_AS_NECESSARY">CALCULATE_AS_NECESSARY</option> | |
| 394 <option value="RECALCULATE">RECALCULATE</option> | |
| 395 </param> | |
| 396 <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;" /> | |
| 397 <param name="use_original_qualities" type="boolean" truevalue="--useOriginalQualities" falsevalue="" label="Use the original base quality scores from the OQ tag" help="-OQ,--useOriginalQualities" /> | |
| 398 <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;"/> | |
| 399 <param name="validation_strictness" type="select" label="How strict should we be with validation" help="-S,--validation_strictness &lt;validation_strictness&gt;"> | |
| 400 <option value="STRICT" selected="True">STRICT</option> | |
| 401 <option value="LENIENT">LENIENT</option> | |
| 402 <option value="SILENT">SILENT</option> | |
| 403 <!-- <option value="DEFAULT_STRINGENCY">DEFAULT_STRINGENCY</option> listed in docs, but not valid value...--> | |
| 404 </param> | |
| 405 <param name="interval_merging" type="select" label="Interval merging rule" help="-im,--interval_merging &lt;interval_merging&gt;"> | |
| 406 <option value="ALL" selected="True">ALL</option> | |
| 407 <option value="OVERLAPPING_ONLY">OVERLAPPING_ONLY</option> | |
| 408 </param> | |
| 409 | |
| 410 <repeat name="read_group_black_list_repeat" title="Read group black list" help="-rgbl,--read_group_black_list &lt;read_group_black_list&gt;"> | |
| 411 <conditional name="read_group_black_list_type"> | |
| 412 <param name="read_group_black_list_type_selector" type="select" label="Type of reads read group black list"> | |
| 413 <option value="file" selected="True">Filters in file</option> | |
| 414 <option value="text">Specify filters as a string</option> | |
| 415 </param> | |
| 416 <when value="file"> | |
| 417 <param name="read_group_black_list" type="data" format="txt" label="Read group black list file" /> | |
| 418 </when> | |
| 419 <when value="text"> | |
| 420 <param name="read_group_black_list" type="text" value="tag:string" label="Read group black list tag:string" /> | |
| 421 </when> | |
| 422 </conditional> | |
| 423 </repeat> | |
| 424 | |
| 425 <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:
17
diff
changeset
|
426 <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"/> |
| 11 | 427 |
| 428 </when> | |
| 429 </conditional> | |
| 430 | |
| 431 <conditional name="analysis_param_type"> | |
| 432 <param name="analysis_param_type_selector" type="select" label="Basic or Advanced Analysis options"> | |
| 433 <option value="basic" selected="True">Basic</option> | |
| 434 <option value="advanced">Advanced</option> | |
| 435 </param> | |
| 436 <when value="basic"> | |
| 437 <!-- Do nothing here --> | |
| 438 </when> | |
| 439 <when value="advanced"> | |
| 440 | |
| 441 <param name="activeRegionIn" type="data" format="bed,gatk_interval,picard_interval_list,vcf" optional="true" label="activeRegionIn" help="--activeRegionIn / -AR Use this interval list file as the active regions to process"/> | |
| 442 <param name="activeRegionOut" type="boolean" checked="False" truevalue="" falsevalue="" label="activeRegionOut" help="--activeRegionOut / -ARO Output the active region to an interval list file"/> | |
| 17 | 443 |
| 444 <param name="annotation" type="select" multiple="True" display="checkboxes" label="Annotation Types" help="-A,--annotation &lt;annotation&gt;"> | |
| 445 <!-- load the available annotations from an external configuration file, since additional ones can be added to local installs --> | |
| 446 <options from_data_table="gatk2_annotations"> | |
| 447 <filter type="multiple_splitter" column="tools_valid_for" separator=","/> | |
| 448 <filter type="static_value" value="UnifiedGenotyper" column="tools_valid_for"/> | |
| 449 </options> | |
| 450 </param> | |
| 451 <repeat name="additional_annotations" title="Additional annotation" help="-A,--annotation &lt;annotation&gt;"> | |
| 452 <param name="additional_annotation_name" type="text" value="" label="Annotation name" /> | |
| 453 </repeat> | |
| 454 <!-- | |
| 455 <conditional name="snpEff_rod_bind_type"> | |
| 456 <param name="snpEff_rod_bind_type_selector" type="select" label="Provide a snpEff reference-ordered data file"> | |
| 457 <option value="set_snpEff">Set snpEff</option> | |
| 458 <option value="exclude_snpEff" selected="True">Don't set snpEff</option> | |
| 459 </param> | |
| 460 <when value="exclude_snpEff"> | |
| 461 </when> | |
| 462 <when value="set_snpEff"> | |
| 463 <param name="snpEff_input_rod" type="data" format="vcf" label="ROD file" /> | |
| 464 <param name="snpEff_rod_name" type="hidden" value="snpEff" label="ROD Name"/> | |
| 465 </when> | |
| 466 </conditional> | |
| 467 --> | |
| 468 <param name="group" type="select" multiple="True" display="checkboxes" label="Annotation Interfaces/Groups" help="-G,--group &lt;group&gt;"> | |
| 469 <option value="RodRequiringAnnotation">RodRequiringAnnotation</option> | |
| 470 <option value="Standard">Standard</option> | |
| 471 <option value="Experimental">Experimental</option> | |
| 472 <option value="WorkInProgress">WorkInProgress</option> | |
| 473 <option value="RankSumTest">RankSumTest</option> | |
| 474 <!-- <option value="none">none</option> --> | |
| 475 </param> | |
| 476 <!-- <param name="family_string" type="text" value="" label="Family String"/> --> | |
| 477 <param name="exclude_annotations" type="select" multiple="True" display="checkboxes" label="Annotations to exclude" help="-XA,--excludeAnnotation &lt;excludeAnnotation&gt;" > | |
| 478 <!-- load the available annotations from an external configuration file, since additional ones can be added to local installs --> | |
| 479 <options from_data_table="gatk2_annotations"> | |
| 480 <filter type="multiple_splitter" column="tools_valid_for" separator=","/> | |
| 481 <filter type="static_value" value="UnifiedGenotyper" column="tools_valid_for"/> | |
| 482 </options> | |
| 483 </param> | |
| 484 | |
| 11 | 485 <param name="comp" type="data" format="vcf" optional="true" label="comp" help="--comp / -comp comparison VCF file"/> |
| 486 <param name="contamination_fraction_to_filter" type="float" value="0.05" optional="true" label="contamination_fraction_to_filter" help="--contamination_fraction_to_filter / -contamination Fraction of contamination in sequencing data (for all samples) to aggressively remove"> | |
| 487 <validator type="in_range" message="value between 0.00 and 1.00" min="0" max="1"/> | |
| 488 </param> | |
| 489 <param name="dbsnp" type="data" format="vcf" optional="true" label="dbsnp" help="--dbsnp / -D dbSNP file"/> | |
| 490 <param name="debug" type="boolean" checked="False" truevalue="-debug" falsevalue="" label="debug" help="--debug / -debug If specified, print out very verbose debug information about each triggering active region"/> | |
| 491 <param name="downsampleRegion" type="integer" value="1000" optional="true" label="downsampleRegion" help="--downsampleRegion / -dr coverage, per-sample, to downsample each active region to"/> | |
| 17 | 492 |
| 493 <conditional name="genotyping_mode_type"> | |
| 494 <param name="genotyping_mode" type="select" label="How to determine the alternate allele to use for genotyping" help="-gt_mode,--genotyping_mode &lt;genotyping_mode&gt;"> | |
| 495 <option value="DISCOVERY" selected="True">DISCOVERY</option> | |
| 496 <option value="GENOTYPE_GIVEN_ALLELES">GENOTYPE_GIVEN_ALLELES</option> | |
| 497 </param> | |
| 498 <when value="DISCOVERY"> | |
| 499 <!-- Do nothing here --> | |
| 500 </when> | |
| 501 <when value="GENOTYPE_GIVEN_ALLELES"> | |
| 502 <param name="input_alleles_rod" type="data" format="vcf" label="Alleles ROD file" help="-alleles,--alleles &lt;alleles&gt;" /> | |
| 503 </when> | |
| 504 </conditional> | |
| 505 | |
| 506 | |
| 11 | 507 <param name="graphOutput" type="boolean" checked="False" truevalue="" falsevalue="" label="graphOutput" help="--graphOutput / -graph File to which debug assembly graph information should be written"/> |
| 508 <param name="heterozygosity" type="float" value="0.0010" optional="true" label="heterozygosity" help="--heterozygosity / -hets Heterozygosity value used to compute prior likelihoods for any locus"/> | |
| 13 | 509 <param name="minPruning" type="integer" value="1" optional="true" label="minPruning" help="--minPruning / -minPruning The minimum allowed pruning factor in assembly graph. Paths with >= X supporting kmers are pruned from the graph"> |
| 11 | 510 <validator type="in_range" message="value between 0 and 127" min="0" max="127"/> |
| 511 </param> | |
| 512 <param name="output_mode" type="select" optional="true" label="output_mode" help="--output_mode / -out_mode Specifies which type of calls we should output"> | |
| 513 <option value="EMIT_VARIANTS_ONLY" selected="True">EMIT_VARIANTS_ONLY</option> | |
| 514 <option value="EMIT_ALL_CONFIDENT_SITES">EMIT_ALL_CONFIDENT_SITES</option> | |
| 515 <option value="EMIT_ALL_SITES">EMIT_ALL_SITES</option> | |
| 516 </param> | |
| 517 <param name="pair_hmm_implementation" type="select" optional="true" label="pair_hmm_implementation" help="--pair_hmm_implementation / -pairHMM The PairHMM implementation to use for genotype likelihood calculations"> | |
| 518 <option value="EXACT">EXACT</option> | |
| 519 <option value="ORIGINAL">ORIGINAL</option> | |
| 520 <option value="CACHING">CACHING</option> | |
| 521 <option value="LOGLESS_CACHING" selected="True">LOGLESS_CACHING</option> | |
| 522 </param> | |
| 523 <param name="standard_min_confidence_threshold_for_calling" type="float" value="30.0" optional="true" label="standard_min_confidence_threshold_for_calling" help="--standard_min_confidence_threshold_for_calling / -stand_call_conf The minimum phred-scaled confidence threshold at which variants should be called"/> | |
| 524 <param name="standard_min_confidence_threshold_for_emitting" type="float" value="30.0" optional="true" label="standard_min_confidence_threshold_for_emitting" help="--standard_min_confidence_threshold_for_emitting / -stand_emit_conf The minimum phred-scaled confidence threshold at which variants should be emitted (and filtered with LowQual if less than the calling threshold)"/> | |
| 525 <param name="useAllelesTrigger" type="boolean" checked="False" truevalue="-allelesTrigger" falsevalue="" label="useAllelesTrigger" help="--useAllelesTrigger / -allelesTrigger If specified, use additional trigger on variants found in an external alleles file"/> | |
| 526 <param name="fullHaplotype" type="boolean" checked="False" truevalue="-fullHaplotype" falsevalue="" label="fullHaplotype" help="--fullHaplotype / -fullHaplotype If specified, output the full haplotype sequence instead of converting to individual variants w.r.t. the reference"/> | |
| 527 <param name="gcpHMM" type="integer" value="10" optional="true" label="gcpHMM" help="--gcpHMM / -gcpHMM Flat gap continuation penalty for use in the Pair HMM"/> | |
| 528 <param name="genotypeFullActiveRegion" type="boolean" checked="False" truevalue="-genotypeFullActiveRegion" falsevalue="" label="genotypeFullActiveRegion" help="--genotypeFullActiveRegion / -genotypeFullActiveRegion If specified, alternate alleles are considered to be the full active region for the purposes of genotyping"/> | |
| 529 <param name="max_alternate_alleles" type="integer" value="6" optional="true" label="max_alternate_alleles" help="--max_alternate_alleles / -maxAltAlleles Maximum number of alternate alleles to genotype"/> | |
| 530 <param name="p_nonref_model" type="select" optional="true" label="p_nonref_model" help="--p_nonref_model / -pnrm Non-reference probability calculation model to employ"> | |
| 531 <option value="EXACT_INDEPENDENT" selected="True">EXACT_INDEPENDENT experimental implementation - for testing only</option> | |
| 532 <option value="EXACT_REFERENCE">EXACT_REFERENCE reference implementation of multi-allelic EXACT model. Extremely slow for many alternate alleles</option> | |
| 533 <option value="EXACT_ORIGINAL">EXACT_ORIGINAL original biallelic exact model, for testing only</option> | |
| 534 <option value="EXACT_GENERAL_PLOIDY">implementation that supports any sample ploidy</option> | |
| 535 </param> | |
| 536 | |
| 537 </when> | |
| 13 | 538 </conditional> |
| 11 | 539 </inputs> |
| 540 <outputs> | |
| 541 <data format="vcf" name="output_vcf" label="${tool.name} on ${on_string} (VCF)" /> | |
| 542 <data format="vcf" name="graph_out" label="${tool.name} on ${on_string} graph" > | |
| 13 | 543 <filter>analysis_param_type['analysis_param_type_selector'] == "advanced" and analysis_param_type['graphOutput'] == True</filter> |
| 11 | 544 </data> |
| 545 <data format="vcf" name="active_region_out" label="${tool.name} on ${on_string} activeRegion" > | |
| 13 | 546 <filter>analysis_param_type['analysis_param_type_selector'] == "advanced" and analysis_param_type['activeRegionOut'] == True</filter> |
| 11 | 547 </data> |
| 548 <data format="txt" name="output_log" label="${tool.name} on ${on_string} (log)" /> | |
| 549 </outputs> | |
| 550 <tests> | |
| 551 <test> | |
| 552 <param name="input_recal" value="gatk/gatk_count_covariates/gatk_count_covariates_out_1.csv" ftype="csv" /> | |
| 553 <param name="reference_source_selector" value="history" /> | |
| 554 <param name="ref_file" value="phiX.fasta" ftype="fasta" /> | |
| 555 <param name="input_bam" value="gatk/gatk_indel_realigner/gatk_indel_realigner_out_1.bam" ftype="bam" /> | |
| 556 <param name="gatk_param_type_selector" value="basic" /> | |
| 557 <param name="analysis_param_type_selector" value="basic" /> | |
| 558 <output name="output_bam" file="gatk/gatk_table_recalibration/gatk_table_recalibration_out_1.bam" ftype="bam" lines_diff="4" /> | |
| 559 <output name="output_log" file="gatk/gatk_table_recalibration/gatk_table_recalibration_out_1.log.contains" compare="contains" /> | |
| 560 </test> | |
| 561 </tests> | |
| 562 <help> | |
| 563 **What it does** | |
| 564 | |
| 14 | 565 **HaplotypeCaller** |
| 566 calls SNPs and indels simultaneously via local de-novo assembly of haplotypes in an active region. | |
| 11 | 567 Haplotypes are evaluated using an affine gap penalty Pair HMM. |
| 568 | |
| 569 For more information on using read based compression in the GATK, see this `tool specific page <http://www.broadinstitute.org/gatk/gatkdocs/org_broadinstitute_sting_gatk_walkers_haplotypecaller_HaplotypeCaller.html>`_. | |
| 570 | |
| 571 To learn about best practices for variant detection using GATK, see this `overview <http://www.broadinstitute.org/gatk/guide/topic?name=best-practices>`_. | |
| 572 | |
| 573 If you encounter errors, please view the `GATK FAQ <http://www.broadinstitute.org/gatk/guide/topic?name=faqs>`_. | |
| 574 | |
| 575 ------ | |
| 576 | |
| 577 **Inputs** | |
| 578 | |
| 14 | 579 GenomeAnalysisTK: PrintReads accepts aligned BAM files. |
| 11 | 580 |
| 581 | |
| 582 **Outputs** | |
| 583 | |
| 584 The output is a VCF file with raw, unrecalibrated SNP and indel calls. | |
| 585 | |
| 586 | |
| 587 Go `here <http://www.broadinstitute.org/gatk/guide/topic?name=intro>`_ for details on GATK file formats. | |
| 588 | |
| 589 ------- | |
| 590 | |
| 591 **Settings**:: | |
| 592 | |
| 12 | 593 activeRegionIn Use this interval list file as the active regions to process |
| 594 activeRegionOut Output the active region to this interval list file | |
| 595 alleles The set of alleles at which to genotype when --genotyping_mode is GENOTYPE_GIVEN_ALLELES | |
| 596 annotation One or more specific annotations to apply to variant calls | |
| 597 comp comparison VCF file | |
| 598 contamination Fraction of contamination in sequencing data (for all samples) to aggressively remove | |
| 599 dbsnp dbSNP file | |
| 600 debug If specified, print out very verbose debug information about each triggering active region | |
| 601 downsampleRegion coverage, per-sample, to downsample each active region to | |
| 602 excludeAnnotation One or more specific annotations to exclude | |
| 603 genotyping_mode Specifies how to determine the alternate alleles to use for genotyping | |
| 604 graphOutput File to which debug assembly graph information should be written | |
| 605 group One or more classes/groups of annotations to apply to variant calls | |
| 606 heterozygosity Heterozygosity value used to compute prior likelihoods for any locus | |
| 607 minPruning The minimum allowed pruning factor in assembly graph. Paths with less than or equal supporting kmers are pruned from the graph | |
| 608 output_mode Specifies which type of calls we should output | |
| 609 pair_hmm_implementation The PairHMM implementation to use for genotype likelihood calculations | |
| 610 stand_call_conf The minimum phred-scaled confidence threshold at which variants should be called | |
| 611 stand_emit_conf The minimum phred-scaled confidence threshold at which variants should be emitted (and filtered with LowQual if less than the calling threshold) | |
| 612 useAllelesTrigger If specified, use additional trigger on variants found in an external alleles file | |
| 613 fullHaplotype If specified, output the full haplotype sequence instead of converting to individual variants w.r.t. the reference | |
| 614 gcpHMM Flat gap continuation penalty for use in the Pair HMM | |
| 615 genotypeFullActiveRegion If specified, alternate alleles are considered to be the full active region for the purposes of genotyping | |
| 616 max_alternate_alleles Maximum number of alternate alleles to genotype | |
| 617 p_nonref_model Non-reference probability calculation model to employ | |
| 618 | |
| 11 | 619 ------ |
| 620 | |
| 621 **Citation** | |
| 622 | |
| 623 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>`_ | |
| 624 | |
| 625 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>`_ | |
| 626 | |
| 627 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>`_ | |
| 628 | |
| 629 </help> | |
| 630 </tool> |