comparison freebayes.xml @ 25:bf27106652f3 draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
author iuc
date Wed, 08 Feb 2017 12:45:05 -0500
parents da6e10dee68b
children a028d13cd860
comparison
equal deleted inserted replaced
24:da6e10dee68b 25:bf27106652f3
1 <tool id="freebayes" name="FreeBayes" version="1.0.2.29--1"> 1 <tool id="freebayes" name="FreeBayes" version="@DEPENDENCY_VERSION@-2">
2 <description> - bayesian genetic variant detector</description> 2 <description>bayesian genetic variant detector</description>
3 <macros>
4 <import>macros.xml</import>
5 </macros>
3 <requirements> 6 <requirements>
4 <requirement type="package" version="1.0.2.29">freebayes</requirement> 7 <requirement type="package" version="@DEPENDENCY_VERSION@">freebayes</requirement>
5 <requirement type="package" version="0.1.19">samtools</requirement> 8 <requirement type="package" version="0.1.19">samtools</requirement>
6 <requirement type="package" version="4.1.3">gawk</requirement> 9 <requirement type="package" version="4.1.3">gawk</requirement>
7 <requirement type="package" version="20160622">parallel</requirement> 10 <requirement type="package" version="20160622">parallel</requirement>
8 </requirements> 11 </requirements>
9 <stdio> 12 <stdio>
10 <exit_code range="1:" /> 13 <exit_code range="1:" />
11 </stdio> 14 </stdio>
12 <command> 15 <command><![CDATA[
13 <![CDATA[
14 ##set up input files 16 ##set up input files
15 17
16 #set $reference_fasta_filename = "localref.fa" 18 #set $reference_fasta_filename = "localref.fa"
17 19
18 #if str( $reference_source.reference_source_selector ) == "history": 20 #if str( $reference_source.reference_source_selector ) == "history":
19 ln -s -f "${reference_source.ref_file}" "${reference_fasta_filename}" && 21 ln -s -f '${reference_source.ref_file}' '${reference_fasta_filename}' &&
20 samtools faidx "${reference_fasta_filename}" 2>&1 || echo "Error running samtools faidx for FreeBayes" >&2 && 22 samtools faidx '${reference_fasta_filename}' 2>&1 || echo "Error running samtools faidx for FreeBayes" >&2 &&
21 #else: 23 #else:
22 #set $reference_fasta_filename = str( $reference_source.ref_file.fields.path ) 24 #set $reference_fasta_filename = str( $reference_source.ref_file.fields.path )
23 #end if 25 #end if
24 26
25 #for $bam_count, $input_bam in enumerate( $reference_source.input_bams ): 27 #for $bam_count, $input_bam in enumerate( $reference_source.input_bams ):
26 ln -s -f "${input_bam}" "b_${bam_count}.bam" && 28 ln -s -f '${input_bam}' 'b_${bam_count}.bam' &&
27 ln -s -f "${input_bam.metadata.bam_index}" "b_${bam_count}.bam.bai" && 29 ln -s -f '${input_bam.metadata.bam_index}' 'b_${bam_count}.bam.bai' &&
28 #end for 30 #end for
29 31
30 ## Tabixize optional input_varinat_vcf file (for --variant-input option) 32 ## Tabixize optional input_variant_vcf file (for --variant-input option)
31 #if ( str( $options_type.options_type_selector ) == 'cline' or str( $options_type.options_type_selector ) == 'full' ) and str( $options_type.optional_inputs.optional_inputs_selector ) == 'set' and str( $options_type.optional_inputs.input_variant_type.input_variant_type_selector ) == "provide_vcf": 33 #if ( str( $options_type.options_type_selector ) == 'cline' or str( $options_type.options_type_selector ) == 'full' ) and str( $options_type.optional_inputs.optional_inputs_selector ) == 'set' and str( $options_type.optional_inputs.input_variant_type.input_variant_type_selector ) == "provide_vcf":
32 ln -s -f "${options_type.optional_inputs.input_variant_type.input_variant_vcf}" "input_variant_vcf.vcf.gz" && 34 ln -s -f '${options_type.optional_inputs.input_variant_type.input_variant_vcf}' 'input_variant_vcf.vcf.gz' &&
33 ln -s -f "${Tabixized_input}" "input_variant_vcf.vcf.gz.tbi" && 35 ln -s -f '${Tabixized_input}' 'input_variant_vcf.vcf.gz.tbi' &&
34 #end if 36 #end if
35 37
36 #for $bam_count, $input_bam in enumerate( $reference_source.input_bams ): 38 #for $bam_count, $input_bam in enumerate( $reference_source.input_bams ):
37 samtools view -H b_${bam_count}.bam | grep "^@SQ" | cut -f 2- | awk '{ gsub("^SN:","",$1); gsub("^LN:","",$2); print $1"\t0\t"$2; }' >> regions_all.bed && 39 samtools view -H b_${bam_count}.bam |
40 grep "^@SQ" |
41 cut -f 2- |
42 awk '{ gsub("^SN:","",$1);
43 gsub("^LN:","",$2);
44 print $1"\t0\t"$2; }' >> regions_all.bed &&
38 #end for 45 #end for
39 46
40 sort -u regions_all.bed > regions_uniq.bed && 47 sort -u regions_all.bed > regions_uniq.bed &&
41 ## split into even small chunks, this has some disatvantages and will not be used for the moment 48 ## split into even small chunks, this has some disatvantages and will not be used for the moment
42 ## bedtools makewindows -b regions_uniq.bed -w 10000000 -s 9990000 > regions.bed && 49 ## bedtools makewindows -b regions_uniq.bed -w 10000000 -s 9990000 > regions.bed &&
48 ## Finished setting up inputs 55 ## Finished setting up inputs
49 56
50 for i in `cat regions_uniq.bed | awk '{print $1":"$2".."$3}'`; 57 for i in `cat regions_uniq.bed | awk '{print $1":"$2".."$3}'`;
51 do 58 do
52 59
53 echo " 60 echo "
54 61
55 ## COMMAND LINE STARTS HERE 62 ## COMMAND LINE STARTS HERE
56 63
57 freebayes 64 freebayes
58 65
59 --region '\$i' 66 --region '\$i'
60 67
61 #for $bam_count, $input_bam in enumerate( $reference_source.input_bams ): 68 #for $bam_count, $input_bam in enumerate( $reference_source.input_bams ):
62 --bam 'b_${bam_count}.bam' 69 --bam 'b_${bam_count}.bam'
63 #end for 70 #end for
64 --fasta-reference '${reference_fasta_filename}' 71 --fasta-reference '${reference_fasta_filename}'
65 72
66 ## Outputs 73 ## Outputs
67 --vcf './vcf_output/part_\$i.vcf' 74 --vcf './vcf_output/part_\$i.vcf'
68 75
69 #if str( $target_limit_type.target_limit_type_selector ) == "limit_by_target_file": 76 #if str( $target_limit_type.target_limit_type_selector ) == "limit_by_target_file":
70 --targets '${target_limit_type.input_target_bed}' 77 --targets '${target_limit_type.input_target_bed}'
71 #elif str( $target_limit_type.target_limit_type_selector ) == "limit_by_region": 78 #elif str( $target_limit_type.target_limit_type_selector ) == "limit_by_region":
72 --region '${target_limit_type.region_chromosome}:${target_limit_type.region_start}..${target_limit_type.region_end}' 79 --region '${target_limit_type.region_chromosome}:${target_limit_type.region_start}..${target_limit_type.region_end}'
73 #end if
74
75 ##advanced options
76 #if str( $options_type.options_type_selector ) == "simple":
77 ##do nothing as command like build up to this point is sufficinet for simple diploid calling
78
79 #elif str( $options_type.options_type_selector ) == "simple_w_filters":
80 --standard-filters
81 --min-coverage '${options_type.min_coverage}'
82 #elif str( $options_type.options_type_selector ) == "naive":
83 --haplotype-length 0
84 --min-alternate-count 1
85 --min-alternate-fraction 0
86 --pooled-continuous
87 --report-monomorphic
88 #elif str( $options_type.options_type_selector ) == "naive_w_filters":
89 --haplotype-length 0
90 --min-alternate-count 1
91 --min-alternate-fraction 0
92 --pooled-continuous
93 --report-monomorphic
94 --standard-filters
95 --min-coverage '${options_type.min_coverage}'
96
97 ## Command line direct text entry is not allowed at this time for security reasons
98 #elif str( $options_type.options_type_selector ) == "full":
99 #if str( $options_type.optional_inputs.optional_inputs_selector ) == 'set':
100 ${options_type.optional_inputs.report_monomorphic}
101
102 #if $options_type.optional_inputs.output_trace_option:
103 --trace ./trace/part_'\$i'.txt
104 #end if
105 #if $options_type.optional_inputs.output_failed_alleles_option:
106 --failed-alleles ./failed_alleles/part_'\$i'.bed
107 #end if
108 #if $options_type.optional_inputs.samples:
109 --samples '${options_type.optional_inputs.samples}'
110 #end if
111 #if $options_type.optional_inputs.populations:
112 --populations '${options_type.optional_inputs.populations}'
113 #end if
114 #if $options_type.optional_inputs.A:
115 --cnv-map '${options_type.optional_inputs.A}'
116 #end if
117 #if str( $options_type.optional_inputs.input_variant_type.input_variant_type_selector ) == "provide_vcf":
118 --variant-input 'input_variant_vcf.vcf.gz' ## input_variant_vcf.vcf.gz is symlinked to a galaxy-generated dataset in "Tabixize optional input_varinat_vcf file" section of the command line above
119 ${options_type.optional_inputs.input_variant_type.only_use_input_alleles}
120 #end if
121 #if $options_type.optional_inputs.haplotype_basis_alleles:
122 --haplotype-basis-alleles '${options_type.optional_inputs.haplotype_basis_alleles}'
123 #end if
124 #if $options_type.optional_inputs.observation_bias:
125 --observation-bias '${options_type.optional_inputs.observation_bias}'
126 #end if
127 #if $options_type.optional_inputs.contamination_estimates:
128 --contamination-estimates '${options_type.optional_inputs.contamination_estimates}'
129 #end if
130 #end if 80 #end if
131 81
132 ## REPORTING 82 ##advanced options
133 #if str( $options_type.reporting.reporting_selector ) == "set": 83 #if str( $options_type.options_type_selector ) == "simple":
134 --pvar ${options_type.reporting.pvar} 84 ##do nothing as command like build up to this point is sufficinet for simple diploid calling
85
86 #elif str( $options_type.options_type_selector ) == "simple_w_filters":
87 --standard-filters
88 --min-coverage '${options_type.min_coverage}'
89 #elif str( $options_type.options_type_selector ) == "naive":
90 --haplotype-length 0
91 --min-alternate-count 1
92 --min-alternate-fraction 0
93 --pooled-continuous
94 --report-monomorphic
95 #elif str( $options_type.options_type_selector ) == "naive_w_filters":
96 --haplotype-length 0
97 --min-alternate-count 1
98 --min-alternate-fraction 0
99 --pooled-continuous
100 --report-monomorphic
101 --standard-filters
102 --min-coverage '${options_type.min_coverage}'
103
104 ## Command line direct text entry is not allowed at this time for security reasons
105 #elif str( $options_type.options_type_selector ) == "full":
106 #if str( $options_type.optional_inputs.optional_inputs_selector ) == 'set':
107 ${options_type.optional_inputs.report_monomorphic}
108
109 #if $options_type.optional_inputs.output_trace_option:
110 --trace ./trace/part_'\$i'.txt
111 #end if
112 #if $options_type.optional_inputs.output_failed_alleles_option:
113 --failed-alleles ./failed_alleles/part_'\$i'.bed
114 #end if
115 #if $options_type.optional_inputs.samples:
116 --samples '${options_type.optional_inputs.samples}'
117 #end if
118 #if $options_type.optional_inputs.populations:
119 --populations '${options_type.optional_inputs.populations}'
120 #end if
121 #if $options_type.optional_inputs.A:
122 --cnv-map '${options_type.optional_inputs.A}'
123 #end if
124 #if str( $options_type.optional_inputs.input_variant_type.input_variant_type_selector ) == "provide_vcf":
125 --variant-input 'input_variant_vcf.vcf.gz' ## input_variant_vcf.vcf.gz is symlinked to a galaxy-generated dataset in "Tabixize optional input_variant_vcf file" section of the command line above
126 ${options_type.optional_inputs.input_variant_type.only_use_input_alleles}
127 #end if
128 #if $options_type.optional_inputs.haplotype_basis_alleles:
129 --haplotype-basis-alleles '${options_type.optional_inputs.haplotype_basis_alleles}'
130 #end if
131 #if $options_type.optional_inputs.observation_bias:
132 --observation-bias '${options_type.optional_inputs.observation_bias}'
133 #end if
134 #if $options_type.optional_inputs.contamination_estimates:
135 --contamination-estimates '${options_type.optional_inputs.contamination_estimates}'
136 #end if
137 #end if
138
139 ## REPORTING
140 #if str( $options_type.reporting.reporting_selector ) == "set":
141 --pvar ${options_type.reporting.pvar}
142 #end if
143 ## POPULATION MODEL
144 #if str( $options_type.population_model.population_model_selector ) == "set":
145 --theta '${options_type.population_model.T}'
146 --ploidy '${options_type.population_model.P}'
147 ${options_type.population_model.J}
148 ${options_type.population_model.K}
149 #end if
150
151 ## REFERENCE ALLELE
152 #if str( $options_type.reference_allele.reference_allele_selector ) == "set":
153 ${options_type.reference_allele.Z}
154 --reference-quality '${options_type.reference_allele.reference_quality}'
155 #end if
156
157 ## ALLELE SCOPE
158 #if str( $options_type.allele_scope.allele_scope_selector ) == "set":
159 ${options_type.allele_scope.I}
160 ${options_type.allele_scope.i}
161 ${options_type.allele_scope.X}
162 ${options_type.allele_scope.u}
163 ${options_type.allele_scope.no_partial_observations}
164
165 -n '${options_type.allele_scope.n}'
166
167 --haplotype-length '${options_type.allele_scope.haplotype_length}'
168 --min-repeat-size '${options_type.allele_scope.min_repeat_length}'
169 --min-repeat-entropy '${options_type.allele_scope.min_repeat_entropy}'
170 #end if
171
172 ## REALIGNMENT
173 ${options_type.O}
174
175 ##INPUT FILTERS
176 #if str( $options_type.input_filters.input_filters_selector ) == "set":
177 ${options_type.input_filters.use_duplicate_reads}
178 -m '${options_type.input_filters.m}'
179 -q '${options_type.input_filters.q}'
180 -R '${options_type.input_filters.R}'
181 -Y '${options_type.input_filters.Y}'
182 -e '${options_type.input_filters.e}'
183 -F '${options_type.input_filters.F}'
184 -C '${options_type.input_filters.C}'
185 -G '${options_type.input_filters.G}'
186
187 #if str( $options_type.input_filters.mismatch_filters.mismatch_filters_selector ) == "set":
188 -Q '${options_type.input_filters.mismatch_filters.Q}'
189 -U '${options_type.input_filters.mismatch_filters.U}'
190 -z '${options_type.input_filters.mismatch_filters.z}'
191
192 --read-snp-limit '${options_type.input_filters.mismatch_filters.read_snp_limit}'
193 #end if
194
195 --min-coverage '${options_type.input_filters.min_coverage}'
196 --min-alternate-qsum "${options_type.input_filters.min_alternate_qsum}"
197 #end if
198
199 ## POPULATION AND MAPPABILITY PRIORS
200 #if str( $options_type.population_mappability_priors.population_mappability_priors_selector ) == "set":
201 ${options_type.population_mappability_priors.k}
202 ${options_type.population_mappability_priors.w}
203 ${options_type.population_mappability_priors.V}
204 ${options_type.population_mappability_priors.a}
205 #end if
206
207 ## GENOTYPE LIKELIHOODS
208 #if str( $options_type.genotype_likelihoods.genotype_likelihoods_selector ) == "set":
209 ${$options_type.genotype_likelihoods.experimental_gls}
210
211 --base-quality-cap '${$options_type.genotype_likelihoods.base_quality_cap}'
212 --prob-contamination '${$options_type.genotype_likelihoods.prob_contamination}'
213 #end if
214
215 ## ALGORITHMIC FEATURES
216 #if str( $options_type.algorithmic_features.algorithmic_features_selector ) == "set":
217 -B '${options_type.algorithmic_features.B}'
218 -W '${options_type.algorithmic_features.W}'
219 -D '${options_type.algorithmic_features.D}'
220
221 #if str( $options_type.algorithmic_features.genotype_variant_threshold.genotype_variant_threshold_selector ) == "set":
222 -S '${options_type.algorithmic_features.genotype_variant_threshold.S}'
223 #end if
224
225 ${options_type.algorithmic_features.N}
226 ${options_type.algorithmic_features.j}
227 ${options_type.algorithmic_features.H}
228 ${options_type.algorithmic_features.genotype_qualities}
229 ${options_type.algorithmic_features.report_genotype_likelihood_max}
230
231 --genotyping-max-banddepth '${options_type.algorithmic_features.genotyping_max_banddepth}'
232 #end if
135 #end if 233 #end if
136 ## POPULATION MODEL 234
137 #if str( $options_type.population_model.population_model_selector ) == "set": 235 ";
138 --theta '${options_type.population_model.T}'
139 --ploidy '${options_type.population_model.P}'
140 ${options_type.population_model.J}
141 ${options_type.population_model.K}
142 #end if
143
144 ## REFERENCE ALLELE
145 #if str( $options_type.reference_allele.reference_allele_selector ) == "set":
146 ${options_type.reference_allele.Z}
147 --reference-quality '${options_type.reference_allele.reference_quality}'
148 #end if
149
150 ## ALLELE SCOPE
151 #if str( $options_type.allele_scope.allele_scope_selector ) == "set":
152 ${options_type.allele_scope.I}
153 ${options_type.allele_scope.i}
154 ${options_type.allele_scope.X}
155 ${options_type.allele_scope.u}
156 -n '${options_type.allele_scope.n}'
157 --haplotype-length '${options_type.allele_scope.haplotype_length}'
158 --min-repeat-size '${options_type.allele_scope.min_repeat_length}'
159 --min-repeat-entropy '${options_type.allele_scope.min_repeat_entropy}'
160 ${options_type.allele_scope.no_partial_observations}
161 #end if
162
163 ## REALIGNMENT
164 ${options_type.O}
165
166 ##INPUT FILTERS
167 #if str( $options_type.input_filters.input_filters_selector ) == "set":
168 ${options_type.input_filters.use_duplicate_reads}
169 -m '${options_type.input_filters.m}'
170 -q '${options_type.input_filters.q}'
171 -R '${options_type.input_filters.R}'
172 -Y '${options_type.input_filters.Y}'
173
174 #if str( $options_type.input_filters.mismatch_filters.mismatch_filters_selector ) == "set":
175 -Q '${options_type.input_filters.mismatch_filters.Q}'
176 -U '${options_type.input_filters.mismatch_filters.U}'
177 -z '${options_type.input_filters.mismatch_filters.z}'
178 --read-snp-limit '${options_type.input_filters.mismatch_filters.read_snp_limit}'
179 #end if
180
181 -e '${options_type.input_filters.e}'
182 -F '${options_type.input_filters.F}'
183 -C '${options_type.input_filters.C}'
184 --min-alternate-qsum "${options_type.input_filters.min_alternate_qsum}"
185 -G '${options_type.input_filters.G}'
186 --min-coverage '${options_type.input_filters.min_coverage}'
187 #end if
188
189 ## POPULATION AND MAPPABILITY PRIORS
190 #if str( $options_type.population_mappability_priors.population_mappability_priors_selector ) == "set":
191 ${options_type.population_mappability_priors.k}
192 ${options_type.population_mappability_priors.w}
193 ${options_type.population_mappability_priors.V}
194 ${options_type.population_mappability_priors.a}
195 #end if
196
197 ## GENOTYPE LIKELIHOODS
198 #if str( $options_type.genotype_likelihoods.genotype_likelihoods_selector ) == "set":
199 --base-quality-cap '${$options_type.genotype_likelihoods.base_quality_cap}'
200 ${$options_type.genotype_likelihoods.experimental_gls}
201 --prob-contamination '${$options_type.genotype_likelihoods.prob_contamination}'
202 #end if
203
204 ## ALGORITHMIC FEATURES
205 #if str( $options_type.algorithmic_features.algorithmic_features_selector ) == "set":
206 ${options_type.algorithmic_features.report_genotype_likelihood_max}
207 -B '${options_type.algorithmic_features.B}'
208 --genotyping-max-banddepth '${options_type.algorithmic_features.genotyping_max_banddepth}'
209 -W '${options_type.algorithmic_features.W}'
210 ${options_type.algorithmic_features.N}
211
212 #if str( $options_type.algorithmic_features.genotype_variant_threshold.genotype_variant_threshold_selector ) == "set":
213 -S '${options_type.algorithmic_features.genotype_variant_threshold.S}'
214 #end if
215
216 ${options_type.algorithmic_features.j}
217 ${options_type.algorithmic_features.H}
218 -D '${options_type.algorithmic_features.D}'
219 ${options_type.algorithmic_features.genotype_qualities}
220 #end if
221 #end if
222
223 ";
224 done > freebayes_commands.sh && 236 done > freebayes_commands.sh &&
225 cat freebayes_commands.sh | parallel --no-notice -j \${GALAXY_SLOTS:-1} && 237
238 cat freebayes_commands.sh |
239 parallel --no-notice -j \${GALAXY_SLOTS:-1} &&
226 240
227 ## make VCF header 241 ## make VCF header
228
229 grep "^#" "./vcf_output/part_\$i.vcf" > header.txt && 242 grep "^#" "./vcf_output/part_\$i.vcf" > header.txt &&
230 243
231 for i in `cat regions_uniq.bed | awk '{print $1":"$2".."$3}'`; 244 for i in `cat regions_uniq.bed | awk '{print $1":"$2".."$3}'`;
232 do 245 do
233 ## if this fails then it bails out the script 246 ## if this fails then it bails out the script
234 cat "./vcf_output/part_\$i.vcf" | grep -v "^#" || true 247 cat "./vcf_output/part_\$i.vcf" | grep -v "^#" || true
235 ; 248 ;
236 done | sort -k1,1 -k2,2n -k5,5 -u | cat header.txt - > "${output_vcf}" 249 done | sort -k1,1 -k2,2n -k5,5 -u | cat header.txt - > '${output_vcf}'
237 250
238 #if str( $options_type.options_type_selector ) == "full": 251 #if str( $options_type.options_type_selector ) == "full":
239 #if str( $options_type.optional_inputs.optional_inputs_selector ) == 'set': 252 #if str( $options_type.optional_inputs.optional_inputs_selector ) == 'set':
240 #if $options_type.optional_inputs.output_failed_alleles_option: 253 #if $options_type.optional_inputs.output_failed_alleles_option:
241 && 254 &&
254 ; 267 ;
255 done > '${output_trace}' 268 done > '${output_trace}'
256 #end if 269 #end if
257 #end if 270 #end if
258 #end if 271 #end if
259 ]]> 272 ]]></command>
260 </command>
261 273
262 <inputs> 274 <inputs>
263 <conditional name="reference_source"> 275 <conditional name="reference_source">
264 <param name="reference_source_selector" type="select" label="Load reference genome from"> 276 <param name="reference_source_selector" type="select" label="Choose the source for the reference genome">
265 <option value="cached">Local cache</option> 277 <option value="cached">Locally cached</option>
266 <option value="history">History</option> 278 <option value="history">History</option>
267 </param> 279 </param>
268 <when value="cached"> 280 <when value="cached">
269 <param name="input_bams" type="data" format="bam" multiple="True" label="BAM file"> 281 <param name="input_bams" type="data" format="bam" multiple="True" label="BAM file">
270 <validator type="unspecified_build" /> 282 <validator type="unspecified_build" />
276 </param> 288 </param>
277 </when> 289 </when>
278 <when value="history"> <!-- FIX ME!!!! --> 290 <when value="history"> <!-- FIX ME!!!! -->
279 <param name="input_bams" type="data" format="bam" multiple="True" label="BAM file" /> 291 <param name="input_bams" type="data" format="bam" multiple="True" label="BAM file" />
280 <param name="ref_file" type="data" format="fasta" label="Use the following dataset as the reference sequence" 292 <param name="ref_file" type="data" format="fasta" label="Use the following dataset as the reference sequence"
281 help="You can upload a FASTA sequence to the history and use it as reference" /> 293 help="You can upload a FASTA sequence to the history and use it as reference" />
282 </when> 294 </when>
283 </conditional> 295 </conditional>
284 <conditional name="target_limit_type"> 296 <conditional name="target_limit_type">
285 <param name="target_limit_type_selector" type="select" label="Limit variant calling to a set of regions?" help="Sets --targets or --region options"> 297 <param name="target_limit_type_selector" type="select" label="Limit variant calling to a set of regions?" help="Sets --targets or --region options">
286 <option value="do_not_limit" selected="True">Do not limit</option> 298 <option value="do_not_limit" selected="True">Do not limit</option>
287 <option value="limit_by_target_file">Limit by target file</option> 299 <option value="limit_by_target_file">Limit by target file</option>
288 <option value="limit_by_region">Limit to region</option> 300 <option value="limit_by_region">Limit to region</option>
289 </param> 301 </param>
290 <when value="do_not_limit"> 302 <when value="do_not_limit" /><!-- Do nothing here -->
291 <!-- Do nothing here -->
292 </when>
293 <when value="limit_by_target_file"> 303 <when value="limit_by_target_file">
294 <param name="input_target_bed" type="data" format="bed" label="Limit analysis to targets listed in the BED-format FILE." help="-t --targets"/> 304 <param name="input_target_bed" type="data" format="bed" label="Limit analysis to regions in a file (BED-format)." argument="--targets"/>
295 </when> 305 </when>
296 <when value="limit_by_region"> 306 <when value="limit_by_region">
297 <param name="region_chromosome" type="text" label="Region Chromosome" value="" help="-r --region"/> <!--only once? --> 307 <param name="region_chromosome" type="text" label="Region Chromosome" value="" argument="--region"/> <!--only once? -->
298 <param name="region_start" type="integer" label="Region Start" value="" /> 308 <param name="region_start" type="integer" label="Region Start" value="" />
299 <param name="region_end" type="integer" label="Region End" value="" /> 309 <param name="region_end" type="integer" label="Region End" value="" />
300 </when> 310 </when>
301 </conditional> 311 </conditional>
302 <conditional name="options_type"> 312 <conditional name="options_type">
303 <param name="options_type_selector" type="select" label="Choose parameter selection level" help="Select how much control over the freebayes run you need" > 313 <param name="options_type_selector" type="select" label="Choose parameter selection level"
304 <option value="simple" selected="True">1:Simple diploid calling</option> 314 help="Select how much control over the freebayes run you need" >
305 <option value="simple_w_filters">2:Simple diploid calling with filtering and coverage</option> 315 <option value="simple" selected="True">1. Simple diploid calling</option>
306 <option value="naive">3:Frequency-based pooled calling</option> 316 <option value="simple_w_filters">2. Simple diploid calling with filtering and coverage</option>
307 <option value="naive_w_filters">4:Frequency-based pooled calling with filtering and coverage</option> 317 <option value="naive">3. Frequency-based pooled calling</option>
308 <option value="full">5:Complete list of all options</option> 318 <option value="naive_w_filters">4. Frequency-based pooled calling with filtering and coverage</option>
309 <!-- We will not alloow command line text boxes at this time 319 <option value="full">5. Full list of options</option>
310 <option value="cline">6:Input parameters on the command line</option>
311 -->
312 </param> 320 </param>
313 <when value="full"> 321 <when value="full">
314 <conditional name="optional_inputs"> 322 <conditional name="optional_inputs">
315 <param name="optional_inputs_selector" type="select" label="Additional inputs" 323 <param name="optional_inputs_selector" type="select" label="Additional inputs"
316 help="Sets --samples, --populations, --cnv-map, --trace, --failed-alleles, --varinat-input, --only-use-input-alleles, --haplotype-basis-alleles, 324 help="Sets --samples, --populations, --cnv-map, --trace, --failed-alleles, --varinat-input, --only-use-input-alleles, --haplotype-basis-alleles,
317 --report-all-haplotype-alleles, --report-monomorphic options, --observation-bias, and --contamination-estimates"> 325 --report-all-haplotype-alleles, --report-monomorphic options, --observation-bias, and --contamination-estimates">
318 <option value="do_not_set" selected="true">Do not provide additional inputs</option> 326 <option value="do_not_set" selected="true">Do not provide additional inputs</option>
319 <option value="set">Provide additional inputs</option> 327 <option value="set">Provide additional inputs</option>
320 </param> 328 </param>
321 <when value="set"> 329 <when value="set">
322 <param name="output_failed_alleles_option" type="boolean" truevalue="--failed-alleles" falsevalue="" checked="False" 330 <param name="output_failed_alleles_option" type="boolean" truevalue="--failed-alleles" falsevalue="" checked="False"
323 label="Write out failed alleles file" help="--failed-alleles" /> 331 label="Write out failed alleles file" argument="--failed-alleles" />
324 <param name="output_trace_option" type="boolean" truevalue="--trace" falsevalue="" checked="False" 332 <param name="output_trace_option" type="boolean" truevalue="--trace" falsevalue="" checked="False"
325 label="Write out algorithm trace file" help="--trace"/> 333 label="Write out algorithm trace file" argument="--trace"/>
326 <param name="samples" type="data" format="txt" label="Limit analysis to samples listed (one per line) in the FILE" optional="True" 334 <param name="samples" type="data" format="txt" label="Limit analysis to samples listed (one per line) in the FILE" optional="True"
327 help="-s --samples; default=By default FreeBayes will analyze all samples in its input BAM files"/> 335 help="default=By default FreeBayes will analyze all samples in its input BAM files" argument="--samples"/>
328 <param name="populations" type="data" format="txt" label="Populations File" optional="True" 336 <param name="populations" type="data" format="txt" label="Populations File" optional="True"
329 help="--populations; default=False. Each line of FILE should list a sample and a population which it is part of. 337 help="Each line of FILE should list a sample and a population which it is part of. The population-based bayesian inference model will
330 The population-based bayesian inference model will then be partitioned on the basis of the populations" /> 338 then be partitioned on the basis of the populations. [default=False]"
339 argument="--populations" />
331 <param name="A" type="data" format="bed" label="Read a copy number map from the BED file FILE" optional="True" 340 <param name="A" type="data" format="bed" label="Read a copy number map from the BED file FILE" optional="True"
332 help="-A --cnv-map; default=copy number is set to as specified by --ploidy. Read a copy number map from the BED file FILE, which has the format: 341 help="default=copy number is set to as specified by --ploidy. Read a copy number map from the BED file FILE, which has the format:
333 reference sequence, start, end, sample name, copy number ... for each region in each sample which does not have the default copy number as set by --ploidy."/> 342 reference sequence, start, end, sample name, copy number ... for each region in each sample which does not have the default copy number as set by --ploidy."
343 argument="--cnv-map" />
334 <conditional name="input_variant_type"> 344 <conditional name="input_variant_type">
335 <param name="input_variant_type_selector" type="select" label="Provide variants file"> 345 <param name="input_variant_type_selector" type="select" label="Provide variants file">
336 <option value="do_not_provide" selected="True">Do not provide</option> 346 <option value="do_not_provide" selected="True">Do not provide</option>
337 <option value="provide_vcf">Provide VCF file</option> 347 <option value="provide_vcf">Provide VCF file</option>
338 </param> 348 </param>
339 <when value="do_not_provide"> 349 <when value="do_not_provide" /><!-- Do nothing here -->
340 <!-- Do nothing here -->
341 </when>
342 <when value="provide_vcf"> 350 <when value="provide_vcf">
343 <param name="input_variant_vcf" type="data" format="vcf_bgzip" label="Use variants reported in VCF file as input to the algorithm"> 351 <param name="input_variant_vcf" type="data" format="vcf_bgzip" label="Use variants reported in VCF file as input to the algorithm" argument="--variant-input">
344 <conversion name="Tabixized_input" type="tabix" /> 352 <conversion name="Tabixized_input" type="tabix" />
345 </param> 353 </param>
346 <param name="only_use_input_alleles" type="boolean" truevalue="--only-use-input-alleles" falsevalue="" checked="False" label="Only provide variant calls and genotype likelihoods for sites in VCF" /> 354 <param name="only_use_input_alleles" type="boolean" truevalue="--only-use-input-alleles" falsevalue="" checked="False"
355 label="Only provide variant calls and genotype likelihoods for sites in VCF" argument="--only-use-input-alleles" />
347 </when> 356 </when>
348 </conditional> 357 </conditional>
349 <param name="haplotype_basis_alleles" type="data" format="vcf" label="Only use variant alleles provided in this input VCF for the construction of complex or haplotype alleles" optional="True" 358 <param name="haplotype_basis_alleles" type="data" format="vcf" label="Only use variant alleles provided in this input VCF for the construction of complex or haplotype alleles" optional="True"
350 help="--haplotype-basis-alleles" /> 359 argument="--haplotype-basis-alleles" />
351 <param name="report_monomorphic" type="boolean" truevalue="--report-monomorphic" falsevalue="" checked="False" 360 <param name="report_monomorphic" type="boolean" truevalue="--report-monomorphic" falsevalue="" checked="False"
352 label="Report even loci which appear to be monomorphic, and report all considered alleles, even those which are not in called genotypes." 361 label="Report even loci which appear to be monomorphic, and report all considered alleles, even those which are not in called genotypes."
353 help="--report-monomorphic " /> 362 argument="--report-monomorphic" />
354 <param name="observation_bias" optional="True" type="data" format="tabular" label="Load read length-dependent allele observation biases from" 363 <param name="observation_bias" optional="True" type="data" format="tabular" label="Load read length-dependent allele observation biases from"
355 help="--observation-bias; The format is [length] [alignment efficiency relative to reference] where the efficiency is 1 if there is no relative observation bias" /> 364 help="The format is [length] [alignment efficiency relative to reference] where the efficiency is 1 if there is no relative observation bias"
365 argument="--observation-bias" />
356 <param name="contamination_estimates" optional="True" type="data" format="tabular" label="Upload per-sample estimates of contamination from" 366 <param name="contamination_estimates" optional="True" type="data" format="tabular" label="Upload per-sample estimates of contamination from"
357 help="--contamination-estimates; The format should be: sample p(read=R|genotype=AR) p(read=A|genotype=AA) Sample '*' can be used to set default contamination estimates." /> 367 help="The format should be: sample p(read=R|genotype=AR) p(read=A|genotype=AA) Sample '*' can be used to set default contamination estimates."
368 argument="--contamination-estimates" />
358 </when> 369 </when>
359 <when value="do_not_set"> 370 <when value="do_not_set" /><!-- do nothing -->
360 <!-- do nothing -->
361 </when>
362 </conditional> 371 </conditional>
372
363 <!-- reporting --> 373 <!-- reporting -->
364 <conditional name="reporting"> 374 <conditional name="reporting">
365 <param name="reporting_selector" type="select" label="Reporting options" help="Sets -P --pvar option"> 375 <param name="reporting_selector" type="select" label="Reporting options" help="Sets -P --pvar option">
366 <option value="do_not_set" selected="True">Use defaults</option> 376 <option value="do_not_set" selected="True">Use defaults</option>
367 <option value="set">Set reporting options</option> 377 <option value="set">Set reporting options</option>
368 </param> 378 </param>
369 <when value="set"> 379 <when value="set">
370 <param name="pvar" type="float" value="0.0" label="Report sites if the probability that there is a polymorphism at the site is greater than" 380 <param name="pvar" type="float" value="0.0" label="Report sites if the probability that there is a polymorphism at the site is greater than"
371 help="-P --pvar; default=0.0. Note that post-filtering is generally recommended over the use of this parameter. " /> 381 help="Note that post-filtering is generally recommended over the use of this parameter. [default=0.0]"
382 argument="--pvar" />
372 </when> 383 </when>
373 <when value="do_not_set"> 384 <when value="do_not_set" /><!-- do nothing -->
374 <!-- do nothing -->
375 </when>
376 </conditional> 385 </conditional>
386
377 <!-- population model --> 387 <!-- population model -->
378 <conditional name="population_model"> 388 <conditional name="population_model">
379 <param name="population_model_selector" type="select" label="Population model options" 389 <param name="population_model_selector" type="select" label="Population model options"
380 help="Sets --theta, --ploidy, --pooled-discrete, and --pooled-continuous options " > 390 help="Sets --theta, --ploidy, --pooled-discrete, and --pooled-continuous options " >
381 <option value="do_not_set" selected="true">Use defaults</option> 391 <option value="do_not_set" selected="true">Use defaults</option>
382 <option value="set">Set population model options</option> 392 <option value="set">Set population model options</option>
383 </param> 393 </param>
384 <when value="set"> 394 <when value="set">
385 <param name="T" type="float" value="0.001" label="The expected mutation rate or pairwise nucleotide diversity among the population under analysis" 395 <param name="T" type="float" value="0.001" label="The expected mutation rate or pairwise nucleotide diversity among the population under analysis"
386 help="-T --theta; default = 0.001. This serves as the single parameter to the Ewens Sampling Formula prior model." /> 396 help="This serves as the single parameter to the Ewens Sampling Formula prior model. [default = 0.001]" argument='--theta'/>
387 <param name="P" type="integer" value="2" label="Set ploidy for the analysis" help="-p --ploidy; default=2" /> 397 <param name="P" type="integer" value="2" label="Set ploidy for the analysis"
398 help="default=2" argument='--ploidy' />
388 <param name="J" type="boolean" truevalue="-J" falsevalue="" checked="False" label="Assume that samples result from pooled sequencing" 399 <param name="J" type="boolean" truevalue="-J" falsevalue="" checked="False" label="Assume that samples result from pooled sequencing"
389 help="-J --pooled-discrete; default=False. Model pooled samples using discrete genotypes across pools. 400 help="Model pooled samples using discrete genotypes across pools. When using this flag, set --ploidy to the number of alleles in each sample or use the --cnv-map to define per-sample ploidy. [default=False]"
390 When using this flag, set --ploidy to the number of alleles in each sample or use the --cnv-map to define per-sample ploidy." /> 401 argument="--pooled-discrete"/>
391 <param name="K" type="boolean" truevalue="-K" falsevalue="" checked="False" label="Output all alleles which pass input filters, regardles of genotyping outcome or model" 402 <param name="K" type="boolean" truevalue="-K" falsevalue="" checked="False" label="Output all alleles which pass input filters, regardles of genotyping outcome or model"
392 help="-K, --poled-continuous; default=False." /> 403 help="default=False." argument="--poled-continuous" />
393 </when> 404 </when>
394 <when value="do_not_set"> 405 <when value="do_not_set" /><!-- do nothing -->
395 <!-- do nothing -->
396 </when>
397 </conditional> 406 </conditional>
407
398 <!-- reference allele --> 408 <!-- reference allele -->
399 <conditional name="reference_allele"> 409 <conditional name="reference_allele">
400 <param name="reference_allele_selector" type="select" label="Reference allele options" 410 <param name="reference_allele_selector" type="select" label="Reference allele options"
401 help="Sets --use-reference-allele and --reference-quality options."> 411 help="Sets --use-reference-allele and --reference-quality options.">
402 <option value="do_not_set" selected="true">Use defaults</option> 412 <option value="do_not_set" selected="true">Use defaults</option>
403 <option value="set">Set reference allele options</option> 413 <option value="set">Set reference allele options</option>
404 </param> 414 </param>
405 <when value="set"> 415 <when value="set">
406 <param name="Z" type="boolean" truevalue="-Z" falsevalue="" checked="False" label="Include the reference allele in the analysis as if it is another sample from the same population" 416 <param name="Z" type="boolean" truevalue="-Z" falsevalue="" checked="False" label="Include the reference allele in the analysis as if it is another sample from the same population"
407 help="-Z --use-reference-allele; default=False" /> 417 help="default=False" argument="--use-reference-allele" />
408 <param name="reference_quality" type="text" value="100,60" label="Assign mapping quality of MQ (100) to the reference allele at each site and base quality of BQ (60)" 418 <param name="reference_quality" type="text" value="100,60" label="Assign mapping quality of MQ (100) to the reference allele at each site and base quality of BQ (60)"
409 help="--reference-quality; default=100,60 " /> 419 help="default=100,60" argument="--reference-quality" />
410 </when> 420 </when>
411 <when value="do_not_set"> 421 <when value="do_not_set" /><!-- do nothing -->
412 <!-- do nothing -->
413 </when>
414 </conditional> 422 </conditional>
423
415 <!-- allelic scope --> 424 <!-- allelic scope -->
416 <conditional name="allele_scope"> 425 <conditional name="allele_scope">
417 <param name="allele_scope_selector" type="select" label="Allelic scope options" 426 <param name="allele_scope_selector" type="select" label="Allelic scope options"
418 help="Sets -I, i, -X, -u, -n, --haplotype-length, --min-repeat-size, --min-repeat-entropy, and --no-partial-observations options."> 427 help="Sets -I, i, -X, -u, -n, --haplotype-length, --min-repeat-size, --min-repeat-entropy, and --no-partial-observations options.">
419 <option value="do_not_set" selected="true">Use defaults</option> 428 <option value="do_not_set" selected="true">Use defaults</option>
420 <option value="set">Set alleic scope options</option> 429 <option value="set">Set alleic scope options</option>
421 </param> 430 </param>
422 <when value="set"> 431 <when value="set">
423 <param name="I" type="boolean" truevalue="-I" falsevalue="" checked="False" label="Ignore SNP alleles" help="-I --no-snps; default=False" /> 432 <param name="I" type="boolean" truevalue="-I" falsevalue="" checked="False" label="Ignore SNP alleles"
424 <param name="i" type="boolean" truevalue="-i" falsevalue="" checked="False" label="Ignore indels alleles" help="-i --no-indels; default=False" /> 433 help="default=False" argument="--no-snps" />
425 <param name="X" type="boolean" truevalue="-X" falsevalue="" checked="False" label="Ignore multi-nucleotide polymorphisms, MNPs" help="-X --no-mnps; default=False" /> 434 <param name="i" type="boolean" truevalue="-i" falsevalue="" checked="False" label="Ignore indels alleles"
435 help="default=False" argument="--no-indels" />
436 <param name="X" type="boolean" truevalue="-X" falsevalue="" checked="False" label="Ignore multi-nucleotide polymorphisms, MNPs"
437 help="default=False" argument="--no-mnps" />
426 <param name="u" type="boolean" truevalue="-u" falsevalue="" checked="False" label="Ignore complex events (composites of other classes)." 438 <param name="u" type="boolean" truevalue="-u" falsevalue="" checked="False" label="Ignore complex events (composites of other classes)."
427 help="-u --no-complex; default=False" /> 439 help="default=False" argument="--no-complex" />
428 <param name="n" type="integer" value="0" label="How many best SNP alleles to evaluate" 440 <param name="n" type="integer" value="0" label="How many best SNP alleles to evaluate"
429 help="-n --use-best-n-alleles; default=0 (all). Alleles are ranked by the sum of supporting quality scores. Set to 0 to evaluate all" /> 441 help="Alleles are ranked by the sum of supporting quality scores. Set to 0 to evaluate all. [default=0 (all)]"
442 argument="--use-best-n-alleles" />
430 <param name="haplotype_length" type="integer" value="3" label="Allow haplotype calls with contiguous embedded matches of up to (nucleotides)" 443 <param name="haplotype_length" type="integer" value="3" label="Allow haplotype calls with contiguous embedded matches of up to (nucleotides)"
431 help="-E --max-complex-gap --haplotype-length; default=3." /> 444 help="-E --max-complex-gap --haplotype-length; default=3." />
432 <param name="min_repeat_length" type="integer" value="5" label="When assembling observations across repeats, require the total repeat length at least this many bp" 445 <param name="min_repeat_length" type="integer" value="5" label="When assembling observations across repeats, require the total repeat length at least this many bp"
433 help="--min-repeat-size; default=5." /> 446 help="default=5." argument="--min-repeat-size" />
434 <param name="min_repeat_entropy" type="integer" value="0" label="To detect interrupted repeats, build across sequence until it has entropy > (bits per bp)" 447 <param name="min_repeat_entropy" type="integer" value="0" label="To detect interrupted repeats, build across sequence until it has entropy > (bits per bp)"
435 help="--min-repeat-entropy; default=0 (off)." /> 448 help="default=0 (off)." argument="--min-repeat-entropy" />
436 <param name="no_partial_observations" type="boolean" truevalue="--no-partial-observations" falsevalue="" checked="False" 449 <param name="no_partial_observations" type="boolean" truevalue="--no-partial-observations" falsevalue="" checked="False"
437 label="Exclude observations which do not fully span the dynamically-determined detection window" 450 label="Exclude observations which do not fully span the dynamically-determined detection window"
438 help="--no-partial-observations; default=use all observations, dividing partial support across matching haplotypes when generating haplotypes." /> 451 help="default=use all observations, dividing partial support across matching haplotypes when generating haplotypes."
452 argument="--no-partial-observations" />
439 </when> 453 </when>
440 <when value="do_not_set"> 454 <when value="do_not_set" /><!-- do nothing -->
441 <!-- do nothing -->
442 </when>
443 </conditional> 455 </conditional>
456
444 <!-- indel realignment --> 457 <!-- indel realignment -->
445 <param name="O" type="boolean" truevalue="-O" falsevalue="" checked="False" label="Turn off left-alignment of indels?" 458 <param name="O" type="boolean" truevalue="-O" falsevalue="" checked="False" label="Turn off left-alignment of indels"
446 help="-O --dont-left-align-indels; default=False (do left align)." /> 459 help="default=False (do left align)." argument="--dont-left-align-indels" />
460
447 <!-- input filters --> 461 <!-- input filters -->
448 <conditional name="input_filters"> 462 <conditional name="input_filters">
449 <param name="input_filters_selector" type="select" label="Input filters" 463 <param name="input_filters_selector" type="select" label="Input filters"
450 help="Sets -4, -m, -q, -R, -Y, -Q, -U, -z, -&#36;, -e, -0, -F, -C, -3, -G, and -&#33; options."> 464 help="Sets -4, -m, -q, -R, -Y, -Q, -U, -z, -&#36;, -e, -0, -F, -C, -3, -G, and -&#33; options.">
451 <option value="do_not_set" selected="true">No input filters (default)</option> 465 <option value="do_not_set" selected="true">No input filters (default)</option>
452 <option value="set">Set input filters</option> 466 <option value="set">Set input filters</option>
453 </param> 467 </param>
454 <when value="set"> 468 <when value="set">
455 <param name="use_duplicate_reads" type="boolean" truevalue="--use-duplicate-reads" falsevalue="" checked="False" 469 <param name="use_duplicate_reads" type="boolean" truevalue="--use-duplicate-reads" falsevalue="" checked="False"
456 label="Include duplicate-marked alignments in the analysis." 470 label="Include duplicate-marked alignments in the analysis."
457 help="-4 --use-duplicate-reads; default=False (exclude duplicates marked as such in alignments)." /> 471 help="default=False (exclude duplicates marked as such in alignments)." argument="--use-duplicate-reads" />
458 <param name="m" type="integer" value="1" label="Exclude alignments from analysis if they have a mapping quality less than" 472 <param name="m" type="integer" value="1" label="Exclude alignments from analysis if they have a mapping quality less than"
459 help="-m --min-mapping-quality; default=1" /> 473 help="default=1" argument="--min-mapping-quality" />
460 <param name="q" type="integer" value="0" label="Exclude alleles from analysis if their supporting base quality less than" 474 <param name="q" type="integer" value="0" label="Exclude alleles from analysis if their supporting base quality less than"
461 help="-q --min-base-quality; default=0" /> 475 help="default=0" argument="--min-base-quality" />
462 <param name="R" type="integer" value="0" label="Consider any allele in which the sum of qualities of supporting observations is at least" 476 <param name="R" type="integer" value="0" label="Consider any allele in which the sum of qualities of supporting observations is at least"
463 help="-R --min-supporting-allele-qsum; default=0" /> 477 help="default=0" argument="--min-supporting-allele-qsum" />
464 <param name="Y" type="integer" value="0" label="Consider any allele in which and the sum of mapping qualities of supporting reads is at least" 478 <param name="Y" type="integer" value="0" label="Consider any allele in which and the sum of mapping qualities of supporting reads is at least"
465 help="-Y --min-supporting-mapping-qsum; default=0" /> 479 help="default=0" argument="--min-supporting-mapping-qsum" />
466 <conditional name="mismatch_filters"> 480 <conditional name="mismatch_filters">
467 <param name="mismatch_filters_selector" type="select" label="Mismatch filters" 481 <param name="mismatch_filters_selector" type="select" label="Mismatch filters"
468 help="Sets -Q, -U, -z, and &#36; options"> 482 help="Sets -Q, -U, -z, and &#36; options">
469 <option value="do_not_set" selected="true">No mismatch filters (default)</option> 483 <option value="do_not_set" selected="true">No mismatch filters (default)</option>
470 <option value="set">Set mismatch filters</option> 484 <option value="set">Set mismatch filters</option>
471 </param> 485 </param>
472 <when value="set"> 486 <when value="set">
473 <param name="Q" type="integer" value="10" label="Count mismatches toward -U (option below) if the base quality of the mismatch is >=" 487 <param name="Q" type="integer" value="10"
474 help="-Q --mismatch-base-quality-threshold; default=10" /> 488 label="Count mismatches toward -U (option below) if the base quality of the mismatch is >="
475 <param name="U" type="integer" value="1000" optional="True" label="Exclude reads with more than N mismatches where each mismatch has base quality >= Q (option above)" 489 help="default=10" argument="--mismatch-base-quality-threshold" />
476 help="-U --read-mismatch-limit; default=~unbound" /> 490 <param name="U" type="integer" value="1000" optional="True"
491 label="Exclude reads with more than N mismatches where each mismatch has base quality >= Q (option above)"
492 help="default=~unbound" argument="--read-mismatch-limit" />
477 <param name="z" type="float" value="1.0" min="0.0" max="1.0" 493 <param name="z" type="float" value="1.0" min="0.0" max="1.0"
478 label="Exclude reads with more than N [0,1] fraction of mismatches where each mismatch has base quality >= Q (second option above)" 494 label="Exclude reads with more than N [0,1] fraction of mismatches where each mismatch has base quality >= Q (second option above)"
479 help="-z --read-max-mismatch-fraction; default=1.0" /> 495 help="default=1.0" argument="--read-max-mismatch-fraction" />
480 <param name="read_snp_limit" type="integer" 496 <param name="read_snp_limit" type="integer"
481 value="1000" label="Exclude reads with more than N base mismatches, ignoring gaps with quality >= Q (third option abobe)" 497 value="1000" label="Exclude reads with more than N base mismatches, ignoring gaps with quality >= Q (third option abobe)"
482 help="-$amp; --read-snp-limit N " /> 498 argument="--read-snp-limit" />
483 </when> 499 </when>
484 <when value="do_not_set"> 500 <when value="do_not_set" /><!-- do nothing -->
485 <!-- do nothing -->
486 </when>
487 </conditional> 501 </conditional>
488 <param name="e" type="integer" value="1000" label="Exclude reads with more than this number of separate gaps" 502 <param name="e" type="integer" value="1000" label="Exclude reads with more than this number of separate gaps"
489 help="-e --read-snp-limit; default=~unbounded" /> 503 help="default=~unbounded" argument="--read-snp-limit" />
490 <param name="standard_filters" type="boolean" truevalue="-0" falsevalue="" checked="False" label="Use stringent input base and mapping quality filters" 504 <param name="standard_filters" type="boolean" truevalue="-0" falsevalue="" checked="False"
491 help="-0 --standard-filters; default=False. Equivalent to -m 30 -q 20 -R 0 -S 0" /> 505 label="Use stringent input base and mapping quality filters"
506 help="default=False. Equivalent to -m 30 -q 20 -R 0 -S 0" argument="--standard-filters"/>
492 <param name="F" type="float" value="0.2" 507 <param name="F" type="float" value="0.2"
493 label="Require at least this fraction of observations supporting an alternate allele within a single individual in the in order to evaluate the position" 508 label="Require at least this fraction of observations supporting an alternate allele within a single individual in the in order to evaluate the position"
494 help="-F --min-alternate-fraction; default=0.2" /> 509 help="default=0.2" argument="--min-alternate-fraction" />
495 <param name="C" type="integer" value="2" 510 <param name="C" type="integer" value="2"
496 label="Require at least this count of observations supporting an alternate allele within a single individual in order to evaluate the position" 511 label="Require at least this count of observations supporting an alternate allele within a single individual in order to evaluate the position"
497 help="-C --min-alternate-count; default=2" /> 512 help="default=2" argument="--min-alternate-count" />
498 <param name="min_alternate_qsum" type="integer" value="0" 513 <param name="min_alternate_qsum" type="integer" value="0"
499 label="Require at least this sum of quality of observations supporting an alternate allele within a single individual in order to evaluate the position" 514 label="Require at least this sum of quality of observations supporting an alternate allele within a single individual in order to evaluate the position"
500 help="-3 --min-alternate-qsum; default=0" /> 515 help="default=0" argument="--min-alternate-qsum" />
501 <param name="G" type="integer" value="1" 516 <param name="G" type="integer" value="1"
502 label="Require at least this count of observations supporting an alternate allele within the total population in order to use the allele in analysis" 517 label="Require at least this count of observations supporting an alternate allele within the total population in order to use the allele in analysis"
503 help="-G --min-alternate-total N; default=1" /> 518 help="default=1" argument="--min-alternate-total" />
504 <param name="min_coverage" type="integer" value="0" label="Require at least this coverage to process a site" 519 <expand macro="par_min_cov" />
505 help="-! --min-coverage; default=0 " />
506 </when> 520 </when>
507 <when value="do_not_set"> 521 <when value="do_not_set" /><!-- do nothing -->
508 <!-- do nothing -->
509 </when>
510 </conditional> 522 </conditional>
523
511 <!-- population and mappability priors --> 524 <!-- population and mappability priors -->
512 <conditional name="population_mappability_priors"> 525 <conditional name="population_mappability_priors">
513 <param name="population_mappability_priors_selector" type="select" label="Population and mappability priors" 526 <param name="population_mappability_priors_selector" type="select" label="Population and mappability priors"
514 help="Sets -k, -w, -V, and -a options."> 527 help="Sets -k, -w, -V, and -a options.">
515 <option value="do_not_set" selected="true">Use defaults</option> 528 <option value="do_not_set" selected="true">Use defaults</option>
516 <option value="set">Set population and mappability priors</option> 529 <option value="set">Set population and mappability priors</option>
517 </param> 530 </param>
518 <when value="set"> 531 <when value="set">
519 <param name="k" type="boolean" truevalue="-k" falsevalue="" checked="False" label="No population priors" 532 <param name="k" type="boolean" truevalue="-k" falsevalue="" checked="False" label="No population priors"
520 help="-k --no-population-priors; default=False. Equivalent to --pooled-discrete --hwe-priors-off and removal of Ewens Sampling Formula component of priors." /> 533 help="default=False. Equivalent to --pooled-discrete --hwe-priors-off and removal of Ewens Sampling Formula component of priors."
534 argument="--no-population-priors" />
521 <param name="w" type="boolean" truevalue="-w" falsevalue="" checked="False" 535 <param name="w" type="boolean" truevalue="-w" falsevalue="" checked="False"
522 label="Disable estimation of the probability of the combination arising under HWE given the allele frequency as estimated by observation frequency" 536 label="Disable estimation of the probability of the combination arising under HWE given the allele frequency as estimated by observation frequency"
523 help="-w --hwe-priors-off; default=False" /> 537 help="default=False" argument="--hwe-priors-off" />
524 <param name="V" type="boolean" truevalue="-V" falsevalue="" checked="False" label="Disable incorporation of prior expectations about observations" 538 <param name="V" type="boolean" truevalue="-V" falsevalue="" checked="False" label="Disable incorporation of prior expectations about observations"
525 help="-V --binomial-obs-priors-off; default=False. Uses read placement probability, strand balance probability, and read position (5&#39;'-3&#39;') probability." /> 539 help="default=False. Uses read placement probability, strand balance probability, and read position (5&#39;'-3&#39;') probability."
540 argument="--binomial-obs-priors-off" />
526 <param name="a" type="boolean" truevalue="-a" falsevalue="" checked="False" 541 <param name="a" type="boolean" truevalue="-a" falsevalue="" checked="False"
527 label="isable use of aggregate probability of observation balance between alleles as a component of the priors" 542 label="Disable use of aggregate probability of observation balance between alleles as a component of the priors"
528 help="-a --allele-balance-priors-off; default=False " /> 543 help="default=False"
544 argument="--allele-balance-priors-off" />
529 </when> 545 </when>
530 <when value="do_not_set"> 546 <when value="do_not_set" /><!-- do nothing -->
531 <!-- do nothing -->
532 </when>
533 </conditional> 547 </conditional>
548
534 <!-- genotype likelihoods --> 549 <!-- genotype likelihoods -->
535 <conditional name="genotype_likelihoods"> 550 <conditional name="genotype_likelihoods">
536 <param name="genotype_likelihoods_selector" type="select" label="Genotype likelihood options" 551 <param name="genotype_likelihoods_selector" type="select" label="Genotype likelihood options"
537 help="Sets --base-quality-cap, --experimental-gls, and --prob-contamination options."> 552 help="Sets --base-quality-cap, --experimental-gls, and --prob-contamination options.">
538 <option value="do_not_set" selected="true">Use defaults</option> 553 <option value="do_not_set" selected="true">Use defaults</option>
539 <option value="set">Set genotype likelihood options</option> 554 <option value="set">Set genotype likelihood options</option>
540 </param> 555 </param>
541 <when value="set"> 556 <when value="set">
542 <param name="base_quality_cap" type="integer" value="0" label="Limit estimated observation quality by capping base quality at" help="--base-quality-cap" /> 557 <param name="base_quality_cap" type="integer" value="0" label="Limit estimated observation quality by capping base quality at"
558 argument="--base-quality-cap" />
543 <param name="experimental_gls" type="boolean" truevalue="--experimental-gls" falsevalue="" checked="False" 559 <param name="experimental_gls" type="boolean" truevalue="--experimental-gls" falsevalue="" checked="False"
544 label="Generate genotype likelihoods using 'effective base depth' metric qual = 1-BaseQual * 1-MapQual" 560 label="Generate genotype likelihoods using 'effective base depth' metric qual = 1-BaseQual * 1-MapQual"
545 help="--experimental-gls; Incorporate partial observations. This is the default when contamination estimates are provided. Optimized for diploid samples." /> 561 help="Incorporate partial observations. This is the default when contamination estimates are provided. Optimized for diploid samples."
562 argument="--experimental-gls" />
546 <param name="prob_contamination" type="float" value="10e-9" label="An estimate of contamination to use for all samples" 563 <param name="prob_contamination" type="float" value="10e-9" label="An estimate of contamination to use for all samples"
547 help="--prob-contamination; default=10e-9." /> 564 help="default=10e-9." argument="--prob-contamination" />
548 </when> 565 </when>
549 <when value="do_not_set"> 566 <when value="do_not_set" /><!-- do nothing -->
550 <!-- do nothing -->
551 </when>
552 </conditional> 567 </conditional>
568
553 <!-- algorithmic features --> 569 <!-- algorithmic features -->
554 <conditional name="algorithmic_features"> 570 <conditional name="algorithmic_features">
555 <param name="algorithmic_features_selector" type="select" label="Algorithmic features" 571 <param name="algorithmic_features_selector" type="select" label="Algorithmic features"
556 help="Sets --report-genotypes-likelihood-max, -B, --genotyping-max-banddepth, -W, -N, S, -j, -H, -D, -= options"> 572 help="Sets --report-genotypes-likelihood-max, -B, --genotyping-max-banddepth, -W, -N, S, -j, -H, -D, -= options">
557 <option value="do_not_set" selected="true">Use defaults</option> 573 <option value="do_not_set" selected="true">Use defaults</option>
558 <option value="set">Set algorithmic features</option> 574 <option value="set">Set algorithmic features</option>
559 </param> 575 </param>
560 <when value="set"> 576 <when value="set">
561 <param name="report_genotype_likelihood_max" type="boolean" truevalue="--report-genotype-likelihood-max" falsevalue="" checked="False" 577 <param name="report_genotype_likelihood_max" type="boolean" truevalue="--report-genotype-likelihood-max" falsevalue="" checked="False"
562 label="Report genotypes using the maximum-likelihood estimate provided from genotype likelihoods." 578 label="Report genotypes using the maximum-likelihood estimate provided from genotype likelihoods."
563 help="--report-genotype-likelihood-max; default=False" /> 579 help="default=False" argument="--report-genotype-likelihood-max" />
564 <param name="B" type="integer" value="1000" label="Iterate no more than N times during genotyping step" 580 <param name="B" type="integer" value="1000" label="Iterate no more than N times during genotyping step"
565 help="-B --genotyping-max-iterations; default=1000." /> 581 help="default=1000." argument="--genotyping-max-iterations" />
566 <param name="genotyping_max_banddepth" type="integer" value="6" label="Integrate no deeper than the Nth best genotype by likelihood when genotyping" 582 <param name="genotyping_max_banddepth" type="integer" value="6" label="Integrate no deeper than the Nth best genotype by likelihood when genotyping"
567 help="--genotyping-max-banddepth; default=6" /> 583 help="default=6" argument="--genotyping-max-banddepth" />
568 <param name="W" type="text" value="1,3" 584 <param name="W" type="text" value="1,3"
569 label="Integrate all genotype combinations in our posterior space which include no more than N (1) samples with their Mth (3) best data likelihood" 585 label="Integrate all genotype combinations in our posterior space which include no more than N (1) samples with their Mth (3) best data likelihood"
570 help="-W --posterior-integration-limits; default=1,3" /> 586 help="default=1,3" argument="--posterior-integration-limits" />
571 <param name="N" type="boolean" truevalue="--exclude-unobserved-genotypes" falsevalue="" checked="False" 587 <param name="N" type="boolean" truevalue="--exclude-unobserved-genotypes" falsevalue="" checked="False"
572 label="Skip sample genotypings for which the sample has no supporting reads" 588 label="Skip sample genotypings for which the sample has no supporting reads"
573 help="-N --exclude-unobserved-genotypes; default=False" /> 589 help="default=False" argument="--exclude-unobserved-genotypes" />
574 <conditional name="genotype_variant_threshold"> 590 <conditional name="genotype_variant_threshold">
575 <param name="genotype_variant_threshold_selector" type="select" 591 <param name="genotype_variant_threshold_selector" type="select"
576 label="Limit posterior integration" 592 label="Limit posterior integration" argument="--genotype-variant-threshold">
577 help="-S --genotype-variant-threshold">
578 <option value="do_not_set" selected="true">Do not limit posterior integration</option> 593 <option value="do_not_set" selected="true">Do not limit posterior integration</option>
579 <option value="set">Set posterior integration limit</option> 594 <option value="set">Set posterior integration limit</option>
580 </param> 595 </param>
581 <when value="do_not_set"> 596 <when value="do_not_set" /><!-- do nothing -->
582 <!-- do nothing -->
583 </when>
584 <when value="set"> 597 <when value="set">
585 <param name="S" value="" type="integer" 598 <param name="S" value="" type="integer"
586 label="Limit posterior integration to samples where the second-best genotype likelihood is no more than log(N) from the highest genotype likelihood for the sample." 599 label="Limit posterior integration to samples where the second-best genotype likelihood is no more than log(N) from the highest genotype likelihood for the sample."
587 help="-S --genotype-variant-threshold; default=~unbounded" /> 600 help="default=~unbounded" argument="--genotype-variant-threshold" />
588 </when> 601 </when>
589 </conditional> 602 </conditional>
590 <param name="j" type="boolean" truevalue="-j" falsevalue="" checked="False" label="Use mapping quality of alleles when calculating data likelihoods" 603 <param name="j" type="boolean" truevalue="-j" falsevalue="" checked="False"
591 help="-j --use-mapping-quality; default=False" /> 604 label="Use mapping quality of alleles when calculating data likelihoods"
605 help="default=False" argument="--use-mapping-quality" />
592 <param name="H" type="boolean" truevalue="-H" falsevalue="" checked="False" 606 <param name="H" type="boolean" truevalue="-H" falsevalue="" checked="False"
593 label="Use a weighted sum of base qualities around an indel, scaled by the distance from the indel" 607 label="Use a weighted sum of base qualities around an indel, scaled by the distance from the indel"
594 help="-H --harmonic-indel-quality; default=use a minimum Base Quality in flanking sequence." /> 608 help="default=use a minimum Base Quality in flanking sequence." argument="--harmonic-indel-quality" />
595 <param name="D" type="float" value="0.9" label="Incorporate non-independence of reads by scaling successive observations by this factor during data likelihood calculations" 609 <param name="D" type="float" value="0.9" label="Incorporate non-independence of reads by scaling successive observations by this factor during data likelihood calculations"
596 help="-D --read-dependence-factor; default=0.9." /> 610 help="default=0.9." argument="--read-dependence-factor" />
597 <param name="genotype_qualities" type="boolean" truevalue="--genotype-qualities" falsevalue="" checked="False" 611 <param name="genotype_qualities" type="boolean" truevalue="--genotype-qualities" falsevalue="" checked="False"
598 label="Calculate the marginal probability of genotypes and report as GQ in each sample field in the VCF output" 612 label="Calculate the marginal probability of genotypes and report as GQ in each sample field in the VCF output"
599 help="-= --genotype-qualities; default=False " /> 613 help="-= --genotype-qualities; default=False " />
600 </when> 614 </when>
601 <when value="do_not_set"> 615 <when value="do_not_set" /><!-- do nothing -->
602 <!-- do nothing -->
603 </when>
604 </conditional> 616 </conditional>
605 </when> 617 </when>
606 <when value="simple"> 618 <when value="simple" /><!-- do nothing -->
607 <!-- do nothing -->
608 </when>
609 <when value="simple_w_filters"> 619 <when value="simple_w_filters">
610 <!-- add standard-filters to command line --> 620 <!-- add standard-filters to command line -->
611 <param name="min_coverage" type="integer" value="0" label="Require at least this coverage to process a site" help="-! --min-coverage; default=0 " /> 621 <expand macro="par_min_cov" />
612 </when> 622 </when>
613 <when value="naive"> 623 <when value="naive">
614 <!-- do nothing build command line using haplotype-length 0 min-alternate-count 1 min-alternate-fraction 0 pooled-continuous report-monomorphic --> 624 <!-- do nothing build command line using haplotype-length 0 min-alternate-count 1 min-alternate-fraction 0 pooled-continuous report-monomorphic -->
615 </when> 625 </when>
616 <when value="naive_w_filters"> 626 <when value="naive_w_filters">
617 <!-- do nothing build command line using haplotype-length 0 min-alternate-count 1 min-alternate-fraction 0 pooled-continuous report-monomorphic standard-filters--> 627 <!-- do nothing build command line using haplotype-length 0 min-alternate-count 1 min-alternate-fraction 0 pooled-continuous report-monomorphic standard-filters-->
618 <param name="min_coverage" type="integer" value="0" label="Require at least this coverage to process a site" help="-! --min-coverage; default=0 " /> 628 <expand macro="par_min_cov" />
619 </when> 629 </when>
620 </conditional> 630 </conditional>
621 </inputs> 631 </inputs>
622 <outputs> 632 <outputs>
623 <data format="vcf" name="output_vcf" label="${tool.name} on ${on_string} (variants)" /> 633 <data format="vcf" name="output_vcf" label="${tool.name} on ${on_string} (variants)" />
685 695
686 ------- 696 -------
687 697
688 **Galaxy-specific options** 698 **Galaxy-specific options**
689 699
690 Galaxy allows six levels of control over FreeBayes options provided by **Choose parameter selection level** menu option. These are: 700 Galaxy allows five levels of control over FreeBayes options provided by **Choose parameter selection level** menu option. These are:
691 701
692 1. *Simple diploid calling*: The simples possible FreeBayes application. Equvalent of using FreeBayes with only a BAM input and no other parameter options. 702 1. *Simple diploid calling*: The simples possible FreeBayes application. Equvalent of using FreeBayes with only a BAM input and no other parameter options.
693 2. *Simple diploid calling with filtering and coverage*: Same as #1 plus two additional options: -0 (standard filters: --min-mapping-quality 30 --min-base-quality 20 --min-supporting-allele-qsum 0 --genotype-varinat-threshold 0) and --min-coverage. 703 2. *Simple diploid calling with filtering and coverage*: Same as #1 plus two additional options: -0 (standard filters: --min-mapping-quality 30 --min-base-quality 20 --min-supporting-allele-qsum 0 --genotype-varinat-threshold 0) and --min-coverage.
694 3. *Frequency-based pooled calling*: This is equivalent to using FreeBayes with the following options: --haplotype-length 0 --min-alternate-count 1 --min-alternate-fraction 0 --pooled-continuous --report-monomorphic. This is the best choice for calling varinats in mixtures such as viral, bacterial, or organellar genomes. 704 3. *Frequency-based pooled calling*: This is equivalent to using FreeBayes with the following options: --haplotype-length 0 --min-alternate-count 1 --min-alternate-fraction 0 --pooled-continuous --report-monomorphic. This is the best choice for calling varinats in mixtures such as viral, bacterial, or organellar genomes.
695 4. *Frequency-based pooled calling with filtering and coverage*: Same as #3 but adds -0 and --min-coverage like in #2. 705 4. *Frequency-based pooled calling with filtering and coverage*: Same as #3 but adds -0 and --min-coverage like in #2.
696 5. *Complete list of all options*: Gives you full control by exposing all FreeBayes options as Galaxy widgets. 706 5. *Complete list of all options*: Gives you full control by exposing all FreeBayes options as Galaxy widgets.
697 707
698 ----- 708 -----
699 709
943 each sample field in the VCF output. 953 each sample field in the VCF output.
944 954
945 955
946 ------ 956 ------
947 957
948 **Citation** 958 **Acknowledgments**
949
950 For the underlying tool, please cite `Erik Garrison and Gabor Marth. Haplotype-based variant detection from short-read sequencing &lt;http://arxiv.org/abs/1207.3907&gt;`_.
951 959
952 The initial version of the wrapper was produced by Dan Blankenberg and upgraded by Anton Nekrutenko. 960 The initial version of the wrapper was produced by Dan Blankenberg and upgraded by Anton Nekrutenko.
953 TNG was developed by Bjoern Gruening 961 TNG was developed by Bjoern Gruening
954
955 </help> 962 </help>
956 <citations> 963 <expand macro="citations" />
957 <citation type="bibtex">@misc{1207.3907,
958 Author = {Erik Garrison},
959 Title = {Haplotype-based variant detection from short-read sequencing},
960 Year = {2012},
961 Eprint = {arXiv:1207.3907},
962 url = {http://arxiv.org/abs/1207.3907},
963 }</citation>
964 </citations>
965 </tool> 964 </tool>