annotate bcftools_merge.xml @ 29:91a6f019e1a9 draft

Uploaded
author wrtz
date Fri, 15 Jan 2016 11:54:12 -0500
parents 73e23f3ff1f3
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
12
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
1 <tool id="bcftools_merge" name="BCFtools merge" version="1.0.0">
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
2 <description>Merge multiple VCF/BCF files</description>
24
73e23f3ff1f3 Uploaded
wrtz
parents: 12
diff changeset
3 <requirements>
73e23f3ff1f3 Uploaded
wrtz
parents: 12
diff changeset
4 <requirement type="package" version="1.3">bcftools</requirement>
73e23f3ff1f3 Uploaded
wrtz
parents: 12
diff changeset
5 </requirements>
12
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
6 <command>
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
7 #for $i, $inp in enumerate( $inputs ):
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
8 #if str( $inp.input_file_index ) != "None":
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
9 ln -s -f "${inp.input}" "input_file_${i}.${inp.input.ext}" &amp;&amp;
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
10 ln -s -f "${inp.input_file_index}" "input_file_${i}.${inp.input.ext}.tbi" &amp;&amp;
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
11 #end if
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
12 #end for
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
13 bcftools merge
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
14 --output "${output_file}"
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
15 --output-type "${output_type}"
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
16 #if str( $regions_file ) != "None":
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
17 --regions-file "${regions_file}"
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
18 #end if
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
19 #if str( $regions ) != "":
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
20 --regions "${regions}"
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
21 #end if
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
22 ${force_samples}
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
23 #if str( $info_rules ) != "":
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
24 --info-rules "${info_rules}"
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
25 #end if
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
26 #if str( $merge ) != "None":
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
27 --merge "${merge}"
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
28 #end if
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
29
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
30 #for $i, $inp in enumerate( $inputs ):
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
31 #if str( $inp.input_file_index ) != "None":
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
32 "input_file_${i}.${inp.input.ext}"
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
33 #else
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
34 "${inp.input}"
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
35 #end if
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
36 #end for
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
37 </command>
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
38 <inputs>
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
39 <repeat name="inputs" title="Input files to merge" default="2" min="2">
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
40 <param name="input" type="data" format="vcf,bcf,bgzip" label="VCF or BCF input file" help="Input file can optionally be compressed and indexed using Bgzip and Tabix Galaxy tools. In this case, select bgzipped file here and index below."/>
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
41 <param name="input_file_index" type="data" optional="true" label="Input file index" help="Tabix-generated index for input file. Run Tabix Galaxy tool on bgzipped input file to create index."/>
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
42 </repeat>
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
43 <param name="output_type" type="select" label="Output data type" help="-O">
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
44 <option value="v" selected="true">VCF</option>
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
45 <option value="b">BCF</option>
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
46 </param>
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
47 <param name="regions_file" type="data" optional="true" label="Regions file" help="-R. Regions specified in a VCF, BED, or tab-delimited file with columns CHROM, POS, and, optionally, POS_TO."/>
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
48 <param name="regions" type="text" size="80" optional="True" label="Regions list" help="-r. Comma-separated list of regions. Format: chr|chr:pos|chr:from-to|chr:from-[,...]">
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
49 <sanitizer invalid_char="">
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
50 <valid initial="string.digits"><add value="CHRchr-:,"/> </valid>
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
51 </sanitizer>
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
52 </param>
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
53 <param name="info_rules" type="text" size="80" optional="True" label="Rules for merging INFO fields" help="-i. Format: &quot;-|TAG:METHOD[,...]&quot;. METHOD can be either &quot;sum&quot;, &quot;avg&quot;, &quot;min&quot;, &quot;max&quot;, or &quot;join&quot;. Default rule string is &quot;DP:sum,DP4:sum&quot;. &quot;-&quot; disables the default rules." />
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
54 <param name="force_samples" type="boolean" checked="False" truevalue="--force-samples" falsevalue="" label="Force samples" help="--force-samples. Proceed even if the merged files contain duplicate sample names. Duplicate sample names are resolved by prepending file index to the conflicting sample name." />
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
55 <param name="merge" type="select" optional="True" label="Multiallelic record types" help="-m. Control what types of multiallelic records can be created.">
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
56 <option value="none">None (Output multiple records instead of multiallelic records)</option>
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
57 <option value="snps">SNPs (Allow multiallelic SNP records)</option>
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
58 <option value="indels">Indels (Allow multiallelic indel records)</option>
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
59 <option value="both">Both (Allow both SNP and indel multiallelic records)</option>
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
60 <option value="all">All (Allow SNP records to be merged with indel records)</option>
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
61 <option value="id">ID (Merge by ID)</option>
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
62 </param>
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
63 </inputs>
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
64 <outputs>
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
65 <data name="output_file" format="vcf" label="${tool.name} on ${on_string}">
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
66 <change_format>
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
67 <when input="output_type" value="b" format="bcf" />
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
68 </change_format>
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
69 </data>
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
70 </outputs>
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
71 <help>
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
72 **About this tool**
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
73
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
74 **BCFtools merge**: Merge multiple VCF/BCF files from non-overlapping sample sets to create one multi-sample file. For example, when merging file A.vcf.gz containing samples S1, S2 and S3 and file B.vcf.gz containing samples S3 and S4, the output file will contain four samples named S1, S2, S3, 2:S3 and S4.
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
75
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
76 Please see https://samtools.github.io/bcftools/bcftools.html for more info on options.
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
77 </help>
3ebaa7bd2773 Uploaded
wrtz
parents:
diff changeset
78 </tool>