annotate haplotype_caller.xml @ 0:340633249b3d draft

Uploaded
author bgruening
date Mon, 02 Dec 2013 06:18:36 -0500
parents
children 8bcc13094767
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
340633249b3d Uploaded
bgruening
parents:
diff changeset
1 <tool id="gatk2_haplotype_caller" name="Haplotype Caller" version="0.0.7">
340633249b3d Uploaded
bgruening
parents:
diff changeset
2 <description>Call SNPs and indels simultaneously via local de-novo assembly of haplotypes in an active region</description>
340633249b3d Uploaded
bgruening
parents:
diff changeset
3 <expand macro="requirements" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
4 <macros>
340633249b3d Uploaded
bgruening
parents:
diff changeset
5 <import>gatk2_macros.xml</import>
340633249b3d Uploaded
bgruening
parents:
diff changeset
6 </macros>
340633249b3d Uploaded
bgruening
parents:
diff changeset
7 <command interpreter="python">
340633249b3d Uploaded
bgruening
parents:
diff changeset
8 gatk2_wrapper.py
340633249b3d Uploaded
bgruening
parents:
diff changeset
9 --stdout "${output_log}"
340633249b3d Uploaded
bgruening
parents:
diff changeset
10 -d "-I" "${reference_source.input_bam}" "${reference_source.input_bam.ext}" "gatk_input"
340633249b3d Uploaded
bgruening
parents:
diff changeset
11 #if str( $reference_source.input_bam.metadata.bam_index ) != "None":
340633249b3d Uploaded
bgruening
parents:
diff changeset
12 -d "" "${reference_source.input_bam.metadata.bam_index}" "bam_index" "gatk_input" ##hardcode galaxy ext type as bam_index
340633249b3d Uploaded
bgruening
parents:
diff changeset
13 #end if
340633249b3d Uploaded
bgruening
parents:
diff changeset
14 -p '
340633249b3d Uploaded
bgruening
parents:
diff changeset
15 @JAR_PATH@
340633249b3d Uploaded
bgruening
parents:
diff changeset
16 -T "HaplotypeCaller"
340633249b3d Uploaded
bgruening
parents:
diff changeset
17 -o "${output_vcf}"
340633249b3d Uploaded
bgruening
parents:
diff changeset
18
340633249b3d Uploaded
bgruening
parents:
diff changeset
19 \$GATK2_SITE_OPTIONS
340633249b3d Uploaded
bgruening
parents:
diff changeset
20
340633249b3d Uploaded
bgruening
parents:
diff changeset
21 @THREADS@
340633249b3d Uploaded
bgruening
parents:
diff changeset
22
340633249b3d Uploaded
bgruening
parents:
diff changeset
23 #if $reference_source.reference_source_selector != "history":
340633249b3d Uploaded
bgruening
parents:
diff changeset
24 -R "${reference_source.ref_file.fields.path}"
340633249b3d Uploaded
bgruening
parents:
diff changeset
25 #end if
340633249b3d Uploaded
bgruening
parents:
diff changeset
26 #if str($input_recal) != 'None':
340633249b3d Uploaded
bgruening
parents:
diff changeset
27 --BQSR "${input_recal}"
340633249b3d Uploaded
bgruening
parents:
diff changeset
28 #end if
340633249b3d Uploaded
bgruening
parents:
diff changeset
29 '
340633249b3d Uploaded
bgruening
parents:
diff changeset
30 #include source=$standard_gatk_options#
340633249b3d Uploaded
bgruening
parents:
diff changeset
31
340633249b3d Uploaded
bgruening
parents:
diff changeset
32 ##start analysis specific options
340633249b3d Uploaded
bgruening
parents:
diff changeset
33 #if $analysis_param_type.analysis_param_type_selector == "advanced":
340633249b3d Uploaded
bgruening
parents:
diff changeset
34 -p '
340633249b3d Uploaded
bgruening
parents:
diff changeset
35 #if $analysis_param_type.p_nonref_model.__str__ != "None" and len($analysis_param_type.p_nonref_model.__str__) > 0:
340633249b3d Uploaded
bgruening
parents:
diff changeset
36 --p_nonref_model $analysis_param_type.p_nonref_model
340633249b3d Uploaded
bgruening
parents:
diff changeset
37 #end if
340633249b3d Uploaded
bgruening
parents:
diff changeset
38 #if $analysis_param_type.heterozygosity.__str__.strip() != '':
340633249b3d Uploaded
bgruening
parents:
diff changeset
39 --heterozygosity $analysis_param_type.heterozygosity
340633249b3d Uploaded
bgruening
parents:
diff changeset
40 #end if
340633249b3d Uploaded
bgruening
parents:
diff changeset
41 --genotyping_mode "${analysis_param_type.genotyping_mode_type.genotyping_mode}"
340633249b3d Uploaded
bgruening
parents:
diff changeset
42 #if str( $analysis_param_type.genotyping_mode_type.genotyping_mode ) == 'GENOTYPE_GIVEN_ALLELES':
340633249b3d Uploaded
bgruening
parents:
diff changeset
43 --alleles "${analysis_param_type.genotyping_mode_type.input_alleles_rod}"
340633249b3d Uploaded
bgruening
parents:
diff changeset
44 #end if
340633249b3d Uploaded
bgruening
parents:
diff changeset
45 #if $analysis_param_type.output_mode.__str__ != "None" and len($analysis_param_type.output_mode.__str__) > 0:
340633249b3d Uploaded
bgruening
parents:
diff changeset
46 --output_mode $analysis_param_type.output_mode
340633249b3d Uploaded
bgruening
parents:
diff changeset
47 #end if
340633249b3d Uploaded
bgruening
parents:
diff changeset
48
340633249b3d Uploaded
bgruening
parents:
diff changeset
49 ## files
340633249b3d Uploaded
bgruening
parents:
diff changeset
50 #if str($analysis_param_type.activeRegionIn) != 'None':
340633249b3d Uploaded
bgruening
parents:
diff changeset
51 --activeRegionIn "$analysis_param_type.activeRegionIn"
340633249b3d Uploaded
bgruening
parents:
diff changeset
52 #end if
340633249b3d Uploaded
bgruening
parents:
diff changeset
53 #if str($analysis_param_type.comp) != 'None':
340633249b3d Uploaded
bgruening
parents:
diff changeset
54 --comp "$analysis_param_type.comp"
340633249b3d Uploaded
bgruening
parents:
diff changeset
55 #end if
340633249b3d Uploaded
bgruening
parents:
diff changeset
56 #if str($analysis_param_type.dbsnp) != 'None':
340633249b3d Uploaded
bgruening
parents:
diff changeset
57 --dbsnp "$analysis_param_type.dbsnp"
340633249b3d Uploaded
bgruening
parents:
diff changeset
58 #end if
340633249b3d Uploaded
bgruening
parents:
diff changeset
59 ##
340633249b3d Uploaded
bgruening
parents:
diff changeset
60 #if str( $analysis_param_type.annotation ) != "None":
340633249b3d Uploaded
bgruening
parents:
diff changeset
61 #for $annotation in str( $analysis_param_type.annotation.fields.gatk_value ).split( ','):
340633249b3d Uploaded
bgruening
parents:
diff changeset
62 --annotation "${annotation}"
340633249b3d Uploaded
bgruening
parents:
diff changeset
63 #end for
340633249b3d Uploaded
bgruening
parents:
diff changeset
64 #end if
340633249b3d Uploaded
bgruening
parents:
diff changeset
65 #for $additional_annotation in $analysis_param_type.additional_annotations:
340633249b3d Uploaded
bgruening
parents:
diff changeset
66 --annotation "${additional_annotation.additional_annotation_name}"
340633249b3d Uploaded
bgruening
parents:
diff changeset
67 #end for
340633249b3d Uploaded
bgruening
parents:
diff changeset
68 #if str( $analysis_param_type.group ) != "None":
340633249b3d Uploaded
bgruening
parents:
diff changeset
69 #for $group in str( $analysis_param_type.group ).split( ','):
340633249b3d Uploaded
bgruening
parents:
diff changeset
70 --group "${group}"
340633249b3d Uploaded
bgruening
parents:
diff changeset
71 #end for
340633249b3d Uploaded
bgruening
parents:
diff changeset
72 #end if
340633249b3d Uploaded
bgruening
parents:
diff changeset
73 #if str( $analysis_param_type.exclude_annotations ) != "None":
340633249b3d Uploaded
bgruening
parents:
diff changeset
74 #for $annotation in str( $analysis_param_type.exclude_annotations.fields.gatk_value ).split( ','):
340633249b3d Uploaded
bgruening
parents:
diff changeset
75 --excludeAnnotation "${annotation}"
340633249b3d Uploaded
bgruening
parents:
diff changeset
76 #end for
340633249b3d Uploaded
bgruening
parents:
diff changeset
77 #end if
340633249b3d Uploaded
bgruening
parents:
diff changeset
78
340633249b3d Uploaded
bgruening
parents:
diff changeset
79 ## value setings
340633249b3d Uploaded
bgruening
parents:
diff changeset
80 #if $analysis_param_type.contamination_fraction_to_filter.__str__.strip() != '':
340633249b3d Uploaded
bgruening
parents:
diff changeset
81 --contamination_fraction_to_filter $analysis_param_type.contamination_fraction_to_filter
340633249b3d Uploaded
bgruening
parents:
diff changeset
82 #end if
340633249b3d Uploaded
bgruening
parents:
diff changeset
83 #if $analysis_param_type.downsampleRegion.__str__.strip() != '':
340633249b3d Uploaded
bgruening
parents:
diff changeset
84 --downsampleRegion $analysis_param_type.downsampleRegion
340633249b3d Uploaded
bgruening
parents:
diff changeset
85 #end if
340633249b3d Uploaded
bgruening
parents:
diff changeset
86 #if $analysis_param_type.minPruning.__str__.strip() != '':
340633249b3d Uploaded
bgruening
parents:
diff changeset
87 --minPruning $analysis_param_type.minPruning
340633249b3d Uploaded
bgruening
parents:
diff changeset
88 #end if
340633249b3d Uploaded
bgruening
parents:
diff changeset
89 #if $analysis_param_type.standard_min_confidence_threshold_for_calling.__str__.strip() != '':
340633249b3d Uploaded
bgruening
parents:
diff changeset
90 --standard_min_confidence_threshold_for_calling $analysis_param_type.standard_min_confidence_threshold_for_calling
340633249b3d Uploaded
bgruening
parents:
diff changeset
91 #end if
340633249b3d Uploaded
bgruening
parents:
diff changeset
92 #if $analysis_param_type.standard_min_confidence_threshold_for_emitting.__str__.strip() != '':
340633249b3d Uploaded
bgruening
parents:
diff changeset
93 --standard_min_confidence_threshold_for_emitting $analysis_param_type.standard_min_confidence_threshold_for_emitting
340633249b3d Uploaded
bgruening
parents:
diff changeset
94 #end if
340633249b3d Uploaded
bgruening
parents:
diff changeset
95 #if $analysis_param_type.gcpHMM.__str__.strip() != '':
340633249b3d Uploaded
bgruening
parents:
diff changeset
96 --gcpHMM $analysis_param_type.gcpHMM
340633249b3d Uploaded
bgruening
parents:
diff changeset
97 #end if
340633249b3d Uploaded
bgruening
parents:
diff changeset
98 #if $analysis_param_type.max_alternate_alleles.__str__.strip() != '':
340633249b3d Uploaded
bgruening
parents:
diff changeset
99 --max_alternate_alleles $analysis_param_type.max_alternate_alleles
340633249b3d Uploaded
bgruening
parents:
diff changeset
100 #end if
340633249b3d Uploaded
bgruening
parents:
diff changeset
101 ## mode selections
340633249b3d Uploaded
bgruening
parents:
diff changeset
102 #if $analysis_param_type.genotyping_mode.__str__ != "None" and len($analysis_param_type.genotyping_mode.__str__) > 0:
340633249b3d Uploaded
bgruening
parents:
diff changeset
103 --genotyping_mode $analysis_param_type.genotyping_mode
340633249b3d Uploaded
bgruening
parents:
diff changeset
104 #end if
340633249b3d Uploaded
bgruening
parents:
diff changeset
105 #if $analysis_param_type.pair_hmm_implementation.__str__ != "None" and len($analysis_param_type.pair_hmm_implementation.__str__) > 0:
340633249b3d Uploaded
bgruening
parents:
diff changeset
106 --pair_hmm_implementation $analysis_param_type.pair_hmm_implementation
340633249b3d Uploaded
bgruening
parents:
diff changeset
107 #end if
340633249b3d Uploaded
bgruening
parents:
diff changeset
108 ## optional outputs
340633249b3d Uploaded
bgruening
parents:
diff changeset
109 #if $analysis_param_type.activeRegionOut:
340633249b3d Uploaded
bgruening
parents:
diff changeset
110 --activeRegionOut $active_region_out
340633249b3d Uploaded
bgruening
parents:
diff changeset
111 #end if
340633249b3d Uploaded
bgruening
parents:
diff changeset
112 #if $analysis_param_type.graphOutput:
340633249b3d Uploaded
bgruening
parents:
diff changeset
113 --graphOutput $graph_out
340633249b3d Uploaded
bgruening
parents:
diff changeset
114 #end if
340633249b3d Uploaded
bgruening
parents:
diff changeset
115 ## flags
340633249b3d Uploaded
bgruening
parents:
diff changeset
116 $analysis_param_type.useAllelesTrigger
340633249b3d Uploaded
bgruening
parents:
diff changeset
117 $analysis_param_type.fullHaplotype
340633249b3d Uploaded
bgruening
parents:
diff changeset
118 $analysis_param_type.genotypeFullActiveRegion
340633249b3d Uploaded
bgruening
parents:
diff changeset
119 $analysis_param_type.debug
340633249b3d Uploaded
bgruening
parents:
diff changeset
120 '
340633249b3d Uploaded
bgruening
parents:
diff changeset
121 #end if
340633249b3d Uploaded
bgruening
parents:
diff changeset
122 </command>
340633249b3d Uploaded
bgruening
parents:
diff changeset
123 <inputs>
340633249b3d Uploaded
bgruening
parents:
diff changeset
124 <param name="input_recal" type="data" format="gatk_report" optional="true" label="Covariates table recalibration file" help="-BQSR,--BQSR &amp;lt;recal_file&amp;gt;" >
340633249b3d Uploaded
bgruening
parents:
diff changeset
125 <help>The input covariates table file which enables on-the-fly base quality score recalibration.
340633249b3d Uploaded
bgruening
parents:
diff changeset
126 Enables on-the-fly recalibrate of base qualities. The covariates tables are produced by the BaseQualityScoreRecalibrator tool.
340633249b3d Uploaded
bgruening
parents:
diff changeset
127 Please be aware that one should only run recalibration with the covariates file created on the same input bam(s).
340633249b3d Uploaded
bgruening
parents:
diff changeset
128 </help>
340633249b3d Uploaded
bgruening
parents:
diff changeset
129 </param>
340633249b3d Uploaded
bgruening
parents:
diff changeset
130 <conditional name="reference_source">
340633249b3d Uploaded
bgruening
parents:
diff changeset
131 <expand macro="reference_source_selector_param" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
132 <when value="cached">
340633249b3d Uploaded
bgruening
parents:
diff changeset
133 <param name="input_bam" type="data" format="bam" label="BAM file" help="-I,--input_file &amp;lt;input_file&amp;gt;">
340633249b3d Uploaded
bgruening
parents:
diff changeset
134 <validator type="unspecified_build" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
135 <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 -->
340633249b3d Uploaded
bgruening
parents:
diff changeset
136 </param>
340633249b3d Uploaded
bgruening
parents:
diff changeset
137 <param name="ref_file" type="select" label="Using reference genome" help="-R,--reference_sequence &amp;lt;reference_sequence&amp;gt;" >
340633249b3d Uploaded
bgruening
parents:
diff changeset
138 <options from_data_table="gatk2_picard_indexes">
340633249b3d Uploaded
bgruening
parents:
diff changeset
139 <filter type="data_meta" key="dbkey" ref="input_bam" column="dbkey"/>
340633249b3d Uploaded
bgruening
parents:
diff changeset
140 </options>
340633249b3d Uploaded
bgruening
parents:
diff changeset
141 <validator type="no_options" message="A built-in reference genome is not available for the build associated with the selected input file"/>
340633249b3d Uploaded
bgruening
parents:
diff changeset
142 </param>
340633249b3d Uploaded
bgruening
parents:
diff changeset
143 </when>
340633249b3d Uploaded
bgruening
parents:
diff changeset
144 <when value="history">
340633249b3d Uploaded
bgruening
parents:
diff changeset
145 <param name="input_bam" type="data" format="bam" label="BAM file" help="-I,--input_file &amp;lt;input_file&amp;gt;" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
146 <param name="ref_file" type="data" format="fasta" label="Using reference file" help="-R,--reference_sequence &amp;lt;reference_sequence&amp;gt;">
340633249b3d Uploaded
bgruening
parents:
diff changeset
147 <options>
340633249b3d Uploaded
bgruening
parents:
diff changeset
148 <filter type="data_meta" key="dbkey" ref="input_bam" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
149 </options>
340633249b3d Uploaded
bgruening
parents:
diff changeset
150 </param>
340633249b3d Uploaded
bgruening
parents:
diff changeset
151 </when>
340633249b3d Uploaded
bgruening
parents:
diff changeset
152 </conditional>
340633249b3d Uploaded
bgruening
parents:
diff changeset
153
340633249b3d Uploaded
bgruening
parents:
diff changeset
154 <expand macro="gatk_param_type_conditional" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
155
340633249b3d Uploaded
bgruening
parents:
diff changeset
156 <conditional name="analysis_param_type">
340633249b3d Uploaded
bgruening
parents:
diff changeset
157 <param name="analysis_param_type_selector" type="select" label="Basic or Advanced Analysis options">
340633249b3d Uploaded
bgruening
parents:
diff changeset
158 <option value="basic" selected="True">Basic</option>
340633249b3d Uploaded
bgruening
parents:
diff changeset
159 <option value="advanced">Advanced</option>
340633249b3d Uploaded
bgruening
parents:
diff changeset
160 </param>
340633249b3d Uploaded
bgruening
parents:
diff changeset
161 <when value="basic">
340633249b3d Uploaded
bgruening
parents:
diff changeset
162 <!-- Do nothing here -->
340633249b3d Uploaded
bgruening
parents:
diff changeset
163 </when>
340633249b3d Uploaded
bgruening
parents:
diff changeset
164 <when value="advanced">
340633249b3d Uploaded
bgruening
parents:
diff changeset
165
340633249b3d Uploaded
bgruening
parents:
diff changeset
166 <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"/>
340633249b3d Uploaded
bgruening
parents:
diff changeset
167 <param name="activeRegionOut" type="boolean" checked="False" truevalue="" falsevalue="" label="activeRegionOut" help="--activeRegionOut / -ARO Output the active region to an interval list file"/>
340633249b3d Uploaded
bgruening
parents:
diff changeset
168
340633249b3d Uploaded
bgruening
parents:
diff changeset
169 <param name="annotation" type="select" multiple="True" display="checkboxes" label="Annotation Types" help="-A,--annotation &amp;lt;annotation&amp;gt;">
340633249b3d Uploaded
bgruening
parents:
diff changeset
170 <!-- load the available annotations from an external configuration file, since additional ones can be added to local installs -->
340633249b3d Uploaded
bgruening
parents:
diff changeset
171 <options from_data_table="gatk2_annotations">
340633249b3d Uploaded
bgruening
parents:
diff changeset
172 <filter type="multiple_splitter" column="tools_valid_for" separator=","/>
340633249b3d Uploaded
bgruening
parents:
diff changeset
173 <filter type="static_value" value="UnifiedGenotyper" column="tools_valid_for"/>
340633249b3d Uploaded
bgruening
parents:
diff changeset
174 </options>
340633249b3d Uploaded
bgruening
parents:
diff changeset
175 </param>
340633249b3d Uploaded
bgruening
parents:
diff changeset
176 <repeat name="additional_annotations" title="Additional annotation" help="-A,--annotation &amp;lt;annotation&amp;gt;">
340633249b3d Uploaded
bgruening
parents:
diff changeset
177 <param name="additional_annotation_name" type="text" value="" label="Annotation name" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
178 </repeat>
340633249b3d Uploaded
bgruening
parents:
diff changeset
179 <!--
340633249b3d Uploaded
bgruening
parents:
diff changeset
180 <conditional name="snpEff_rod_bind_type">
340633249b3d Uploaded
bgruening
parents:
diff changeset
181 <param name="snpEff_rod_bind_type_selector" type="select" label="Provide a snpEff reference-ordered data file">
340633249b3d Uploaded
bgruening
parents:
diff changeset
182 <option value="set_snpEff">Set snpEff</option>
340633249b3d Uploaded
bgruening
parents:
diff changeset
183 <option value="exclude_snpEff" selected="True">Don't set snpEff</option>
340633249b3d Uploaded
bgruening
parents:
diff changeset
184 </param>
340633249b3d Uploaded
bgruening
parents:
diff changeset
185 <when value="exclude_snpEff">
340633249b3d Uploaded
bgruening
parents:
diff changeset
186 </when>
340633249b3d Uploaded
bgruening
parents:
diff changeset
187 <when value="set_snpEff">
340633249b3d Uploaded
bgruening
parents:
diff changeset
188 <param name="snpEff_input_rod" type="data" format="vcf" label="ROD file" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
189 <param name="snpEff_rod_name" type="hidden" value="snpEff" label="ROD Name"/>
340633249b3d Uploaded
bgruening
parents:
diff changeset
190 </when>
340633249b3d Uploaded
bgruening
parents:
diff changeset
191 </conditional>
340633249b3d Uploaded
bgruening
parents:
diff changeset
192 -->
340633249b3d Uploaded
bgruening
parents:
diff changeset
193 <param name="group" type="select" multiple="True" display="checkboxes" label="Annotation Interfaces/Groups" help="-G,--group &amp;lt;group&amp;gt;">
340633249b3d Uploaded
bgruening
parents:
diff changeset
194 <option value="RodRequiringAnnotation">RodRequiringAnnotation</option>
340633249b3d Uploaded
bgruening
parents:
diff changeset
195 <option value="Standard">Standard</option>
340633249b3d Uploaded
bgruening
parents:
diff changeset
196 <option value="Experimental">Experimental</option>
340633249b3d Uploaded
bgruening
parents:
diff changeset
197 <option value="WorkInProgress">WorkInProgress</option>
340633249b3d Uploaded
bgruening
parents:
diff changeset
198 <option value="RankSumTest">RankSumTest</option>
340633249b3d Uploaded
bgruening
parents:
diff changeset
199 <!-- <option value="none">none</option> -->
340633249b3d Uploaded
bgruening
parents:
diff changeset
200 </param>
340633249b3d Uploaded
bgruening
parents:
diff changeset
201 <!-- <param name="family_string" type="text" value="" label="Family String"/> -->
340633249b3d Uploaded
bgruening
parents:
diff changeset
202 <param name="exclude_annotations" type="select" multiple="True" display="checkboxes" label="Annotations to exclude" help="-XA,--excludeAnnotation &amp;lt;excludeAnnotation&amp;gt;" >
340633249b3d Uploaded
bgruening
parents:
diff changeset
203 <!-- load the available annotations from an external configuration file, since additional ones can be added to local installs -->
340633249b3d Uploaded
bgruening
parents:
diff changeset
204 <options from_data_table="gatk2_annotations">
340633249b3d Uploaded
bgruening
parents:
diff changeset
205 <filter type="multiple_splitter" column="tools_valid_for" separator=","/>
340633249b3d Uploaded
bgruening
parents:
diff changeset
206 <filter type="static_value" value="UnifiedGenotyper" column="tools_valid_for"/>
340633249b3d Uploaded
bgruening
parents:
diff changeset
207 </options>
340633249b3d Uploaded
bgruening
parents:
diff changeset
208 </param>
340633249b3d Uploaded
bgruening
parents:
diff changeset
209
340633249b3d Uploaded
bgruening
parents:
diff changeset
210 <param name="comp" type="data" format="vcf" optional="true" label="comp" help="--comp / -comp comparison VCF file"/>
340633249b3d Uploaded
bgruening
parents:
diff changeset
211 <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">
340633249b3d Uploaded
bgruening
parents:
diff changeset
212 <validator type="in_range" message="value between 0.00 and 1.00" min="0" max="1"/>
340633249b3d Uploaded
bgruening
parents:
diff changeset
213 </param>
340633249b3d Uploaded
bgruening
parents:
diff changeset
214 <param name="dbsnp" type="data" format="vcf" optional="true" label="dbsnp" help="--dbsnp / -D dbSNP file"/>
340633249b3d Uploaded
bgruening
parents:
diff changeset
215 <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"/>
340633249b3d Uploaded
bgruening
parents:
diff changeset
216 <param name="downsampleRegion" type="integer" value="1000" optional="true" label="downsampleRegion" help="--downsampleRegion / -dr coverage, per-sample, to downsample each active region to"/>
340633249b3d Uploaded
bgruening
parents:
diff changeset
217
340633249b3d Uploaded
bgruening
parents:
diff changeset
218 <conditional name="genotyping_mode_type">
340633249b3d Uploaded
bgruening
parents:
diff changeset
219 <param name="genotyping_mode" type="select" label="How to determine the alternate allele to use for genotyping" help="-gt_mode,--genotyping_mode &amp;lt;genotyping_mode&amp;gt;">
340633249b3d Uploaded
bgruening
parents:
diff changeset
220 <option value="DISCOVERY" selected="True">DISCOVERY</option>
340633249b3d Uploaded
bgruening
parents:
diff changeset
221 <option value="GENOTYPE_GIVEN_ALLELES">GENOTYPE_GIVEN_ALLELES</option>
340633249b3d Uploaded
bgruening
parents:
diff changeset
222 </param>
340633249b3d Uploaded
bgruening
parents:
diff changeset
223 <when value="DISCOVERY">
340633249b3d Uploaded
bgruening
parents:
diff changeset
224 <!-- Do nothing here -->
340633249b3d Uploaded
bgruening
parents:
diff changeset
225 </when>
340633249b3d Uploaded
bgruening
parents:
diff changeset
226 <when value="GENOTYPE_GIVEN_ALLELES">
340633249b3d Uploaded
bgruening
parents:
diff changeset
227 <param name="input_alleles_rod" type="data" format="vcf" label="Alleles ROD file" help="-alleles,--alleles &amp;lt;alleles&amp;gt;" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
228 </when>
340633249b3d Uploaded
bgruening
parents:
diff changeset
229 </conditional>
340633249b3d Uploaded
bgruening
parents:
diff changeset
230
340633249b3d Uploaded
bgruening
parents:
diff changeset
231
340633249b3d Uploaded
bgruening
parents:
diff changeset
232 <param name="graphOutput" type="boolean" checked="False" truevalue="" falsevalue="" label="graphOutput" help="--graphOutput / -graph File to which debug assembly graph information should be written"/>
340633249b3d Uploaded
bgruening
parents:
diff changeset
233 <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"/>
340633249b3d Uploaded
bgruening
parents:
diff changeset
234 <param name="minPruning" type="integer" value="1" optional="true" label="minPruning" help="--minPruning / -minPruning The minimum allowed pruning factor in assembly graph. Paths with &gt;= X supporting kmers are pruned from the graph">
340633249b3d Uploaded
bgruening
parents:
diff changeset
235 <validator type="in_range" message="value between 0 and 127" min="0" max="127"/>
340633249b3d Uploaded
bgruening
parents:
diff changeset
236 </param>
340633249b3d Uploaded
bgruening
parents:
diff changeset
237 <param name="output_mode" type="select" optional="true" label="output_mode" help="--output_mode / -out_mode Specifies which type of calls we should output">
340633249b3d Uploaded
bgruening
parents:
diff changeset
238 <option value="EMIT_VARIANTS_ONLY" selected="True">EMIT_VARIANTS_ONLY</option>
340633249b3d Uploaded
bgruening
parents:
diff changeset
239 <option value="EMIT_ALL_CONFIDENT_SITES">EMIT_ALL_CONFIDENT_SITES</option>
340633249b3d Uploaded
bgruening
parents:
diff changeset
240 <option value="EMIT_ALL_SITES">EMIT_ALL_SITES</option>
340633249b3d Uploaded
bgruening
parents:
diff changeset
241 </param>
340633249b3d Uploaded
bgruening
parents:
diff changeset
242 <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">
340633249b3d Uploaded
bgruening
parents:
diff changeset
243 <option value="EXACT">EXACT</option>
340633249b3d Uploaded
bgruening
parents:
diff changeset
244 <option value="ORIGINAL">ORIGINAL</option>
340633249b3d Uploaded
bgruening
parents:
diff changeset
245 <option value="CACHING">CACHING</option>
340633249b3d Uploaded
bgruening
parents:
diff changeset
246 <option value="LOGLESS_CACHING" selected="True">LOGLESS_CACHING</option>
340633249b3d Uploaded
bgruening
parents:
diff changeset
247 </param>
340633249b3d Uploaded
bgruening
parents:
diff changeset
248 <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"/>
340633249b3d Uploaded
bgruening
parents:
diff changeset
249 <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)"/>
340633249b3d Uploaded
bgruening
parents:
diff changeset
250 <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"/>
340633249b3d Uploaded
bgruening
parents:
diff changeset
251 <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"/>
340633249b3d Uploaded
bgruening
parents:
diff changeset
252 <param name="gcpHMM" type="integer" value="10" optional="true" label="gcpHMM" help="--gcpHMM / -gcpHMM Flat gap continuation penalty for use in the Pair HMM"/>
340633249b3d Uploaded
bgruening
parents:
diff changeset
253 <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"/>
340633249b3d Uploaded
bgruening
parents:
diff changeset
254 <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"/>
340633249b3d Uploaded
bgruening
parents:
diff changeset
255 <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">
340633249b3d Uploaded
bgruening
parents:
diff changeset
256 <option value="EXACT_INDEPENDENT" selected="True">EXACT_INDEPENDENT experimental implementation - for testing only</option>
340633249b3d Uploaded
bgruening
parents:
diff changeset
257 <option value="EXACT_REFERENCE">EXACT_REFERENCE reference implementation of multi-allelic EXACT model. Extremely slow for many alternate alleles</option>
340633249b3d Uploaded
bgruening
parents:
diff changeset
258 <option value="EXACT_ORIGINAL">EXACT_ORIGINAL original biallelic exact model, for testing only</option>
340633249b3d Uploaded
bgruening
parents:
diff changeset
259 <option value="EXACT_GENERAL_PLOIDY">implementation that supports any sample ploidy</option>
340633249b3d Uploaded
bgruening
parents:
diff changeset
260 </param>
340633249b3d Uploaded
bgruening
parents:
diff changeset
261
340633249b3d Uploaded
bgruening
parents:
diff changeset
262 </when>
340633249b3d Uploaded
bgruening
parents:
diff changeset
263 </conditional>
340633249b3d Uploaded
bgruening
parents:
diff changeset
264 </inputs>
340633249b3d Uploaded
bgruening
parents:
diff changeset
265 <outputs>
340633249b3d Uploaded
bgruening
parents:
diff changeset
266 <data format="vcf" name="output_vcf" label="${tool.name} on ${on_string} (VCF)" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
267 <data format="vcf" name="graph_out" label="${tool.name} on ${on_string} graph" >
340633249b3d Uploaded
bgruening
parents:
diff changeset
268 <filter>analysis_param_type['analysis_param_type_selector'] == "advanced" and analysis_param_type['graphOutput'] == True</filter>
340633249b3d Uploaded
bgruening
parents:
diff changeset
269 </data>
340633249b3d Uploaded
bgruening
parents:
diff changeset
270 <data format="vcf" name="active_region_out" label="${tool.name} on ${on_string} activeRegion" >
340633249b3d Uploaded
bgruening
parents:
diff changeset
271 <filter>analysis_param_type['analysis_param_type_selector'] == "advanced" and analysis_param_type['activeRegionOut'] == True</filter>
340633249b3d Uploaded
bgruening
parents:
diff changeset
272 </data>
340633249b3d Uploaded
bgruening
parents:
diff changeset
273 <data format="txt" name="output_log" label="${tool.name} on ${on_string} (log)" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
274 </outputs>
340633249b3d Uploaded
bgruening
parents:
diff changeset
275 <tests>
340633249b3d Uploaded
bgruening
parents:
diff changeset
276 <test>
340633249b3d Uploaded
bgruening
parents:
diff changeset
277 <param name="input_recal" value="gatk/gatk_count_covariates/gatk_count_covariates_out_1.csv" ftype="csv" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
278 <param name="reference_source_selector" value="history" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
279 <param name="ref_file" value="phiX.fasta" ftype="fasta" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
280 <param name="input_bam" value="gatk/gatk_indel_realigner/gatk_indel_realigner_out_1.bam" ftype="bam" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
281 <param name="gatk_param_type_selector" value="basic" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
282 <param name="analysis_param_type_selector" value="basic" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
283 <output name="output_bam" file="gatk/gatk_table_recalibration/gatk_table_recalibration_out_1.bam" ftype="bam" lines_diff="4" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
284 <output name="output_log" file="gatk/gatk_table_recalibration/gatk_table_recalibration_out_1.log.contains" compare="contains" />
340633249b3d Uploaded
bgruening
parents:
diff changeset
285 </test>
340633249b3d Uploaded
bgruening
parents:
diff changeset
286 </tests>
340633249b3d Uploaded
bgruening
parents:
diff changeset
287 <help>
340633249b3d Uploaded
bgruening
parents:
diff changeset
288 **What it does**
340633249b3d Uploaded
bgruening
parents:
diff changeset
289
340633249b3d Uploaded
bgruening
parents:
diff changeset
290 **HaplotypeCaller**
340633249b3d Uploaded
bgruening
parents:
diff changeset
291 calls SNPs and indels simultaneously via local de-novo assembly of haplotypes in an active region.
340633249b3d Uploaded
bgruening
parents:
diff changeset
292 Haplotypes are evaluated using an affine gap penalty Pair HMM.
340633249b3d Uploaded
bgruening
parents:
diff changeset
293
340633249b3d Uploaded
bgruening
parents:
diff changeset
294 For more information on using read based compression in the GATK, see this `tool specific page &lt;http://www.broadinstitute.org/gatk/gatkdocs/org_broadinstitute_sting_gatk_walkers_haplotypecaller_HaplotypeCaller.html&gt;`_.
340633249b3d Uploaded
bgruening
parents:
diff changeset
295
340633249b3d Uploaded
bgruening
parents:
diff changeset
296 To learn about best practices for variant detection using GATK, see this `overview &lt;http://www.broadinstitute.org/gatk/guide/topic?name=best-practices&gt;`_.
340633249b3d Uploaded
bgruening
parents:
diff changeset
297
340633249b3d Uploaded
bgruening
parents:
diff changeset
298 If you encounter errors, please view the `GATK FAQ &lt;http://www.broadinstitute.org/gatk/guide/topic?name=faqs&gt;`_.
340633249b3d Uploaded
bgruening
parents:
diff changeset
299
340633249b3d Uploaded
bgruening
parents:
diff changeset
300 ------
340633249b3d Uploaded
bgruening
parents:
diff changeset
301
340633249b3d Uploaded
bgruening
parents:
diff changeset
302 **Inputs**
340633249b3d Uploaded
bgruening
parents:
diff changeset
303
340633249b3d Uploaded
bgruening
parents:
diff changeset
304 GenomeAnalysisTK: PrintReads accepts aligned BAM files.
340633249b3d Uploaded
bgruening
parents:
diff changeset
305
340633249b3d Uploaded
bgruening
parents:
diff changeset
306
340633249b3d Uploaded
bgruening
parents:
diff changeset
307 **Outputs**
340633249b3d Uploaded
bgruening
parents:
diff changeset
308
340633249b3d Uploaded
bgruening
parents:
diff changeset
309 The output is a VCF file with raw, unrecalibrated SNP and indel calls.
340633249b3d Uploaded
bgruening
parents:
diff changeset
310
340633249b3d Uploaded
bgruening
parents:
diff changeset
311
340633249b3d Uploaded
bgruening
parents:
diff changeset
312 Go `here &lt;http://www.broadinstitute.org/gatk/guide/topic?name=intro&gt;`_ for details on GATK file formats.
340633249b3d Uploaded
bgruening
parents:
diff changeset
313
340633249b3d Uploaded
bgruening
parents:
diff changeset
314 -------
340633249b3d Uploaded
bgruening
parents:
diff changeset
315
340633249b3d Uploaded
bgruening
parents:
diff changeset
316 **Settings**::
340633249b3d Uploaded
bgruening
parents:
diff changeset
317
340633249b3d Uploaded
bgruening
parents:
diff changeset
318 activeRegionIn Use this interval list file as the active regions to process
340633249b3d Uploaded
bgruening
parents:
diff changeset
319 activeRegionOut Output the active region to this interval list file
340633249b3d Uploaded
bgruening
parents:
diff changeset
320 alleles The set of alleles at which to genotype when --genotyping_mode is GENOTYPE_GIVEN_ALLELES
340633249b3d Uploaded
bgruening
parents:
diff changeset
321 annotation One or more specific annotations to apply to variant calls
340633249b3d Uploaded
bgruening
parents:
diff changeset
322 comp comparison VCF file
340633249b3d Uploaded
bgruening
parents:
diff changeset
323 contamination Fraction of contamination in sequencing data (for all samples) to aggressively remove
340633249b3d Uploaded
bgruening
parents:
diff changeset
324 dbsnp dbSNP file
340633249b3d Uploaded
bgruening
parents:
diff changeset
325 debug If specified, print out very verbose debug information about each triggering active region
340633249b3d Uploaded
bgruening
parents:
diff changeset
326 downsampleRegion coverage, per-sample, to downsample each active region to
340633249b3d Uploaded
bgruening
parents:
diff changeset
327 excludeAnnotation One or more specific annotations to exclude
340633249b3d Uploaded
bgruening
parents:
diff changeset
328 genotyping_mode Specifies how to determine the alternate alleles to use for genotyping
340633249b3d Uploaded
bgruening
parents:
diff changeset
329 graphOutput File to which debug assembly graph information should be written
340633249b3d Uploaded
bgruening
parents:
diff changeset
330 group One or more classes/groups of annotations to apply to variant calls
340633249b3d Uploaded
bgruening
parents:
diff changeset
331 heterozygosity Heterozygosity value used to compute prior likelihoods for any locus
340633249b3d Uploaded
bgruening
parents:
diff changeset
332 minPruning The minimum allowed pruning factor in assembly graph. Paths with less than or equal supporting kmers are pruned from the graph
340633249b3d Uploaded
bgruening
parents:
diff changeset
333 output_mode Specifies which type of calls we should output
340633249b3d Uploaded
bgruening
parents:
diff changeset
334 pair_hmm_implementation The PairHMM implementation to use for genotype likelihood calculations
340633249b3d Uploaded
bgruening
parents:
diff changeset
335 stand_call_conf The minimum phred-scaled confidence threshold at which variants should be called
340633249b3d Uploaded
bgruening
parents:
diff changeset
336 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)
340633249b3d Uploaded
bgruening
parents:
diff changeset
337 useAllelesTrigger If specified, use additional trigger on variants found in an external alleles file
340633249b3d Uploaded
bgruening
parents:
diff changeset
338 fullHaplotype If specified, output the full haplotype sequence instead of converting to individual variants w.r.t. the reference
340633249b3d Uploaded
bgruening
parents:
diff changeset
339 gcpHMM Flat gap continuation penalty for use in the Pair HMM
340633249b3d Uploaded
bgruening
parents:
diff changeset
340 genotypeFullActiveRegion If specified, alternate alleles are considered to be the full active region for the purposes of genotyping
340633249b3d Uploaded
bgruening
parents:
diff changeset
341 max_alternate_alleles Maximum number of alternate alleles to genotype
340633249b3d Uploaded
bgruening
parents:
diff changeset
342 p_nonref_model Non-reference probability calculation model to employ
340633249b3d Uploaded
bgruening
parents:
diff changeset
343
340633249b3d Uploaded
bgruening
parents:
diff changeset
344 ------
340633249b3d Uploaded
bgruening
parents:
diff changeset
345
340633249b3d Uploaded
bgruening
parents:
diff changeset
346 @CITATION_SECTION@
340633249b3d Uploaded
bgruening
parents:
diff changeset
347 </help>
340633249b3d Uploaded
bgruening
parents:
diff changeset
348 </tool>