annotate bcftools_merge.xml @ 4:2cffdec901f5 draft

Uploaded
author wrtz
date Thu, 14 Jan 2016 17:47:22 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
1 <tool id="bcftools_merge" name="BCFtools merge" version="1.0.0">
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
2 <description>Merge multiple VCF/BCF files</description>
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
3 <command>
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
4 #for $i, $inp in enumerate( $inputs ):
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
5 #if str( $inp.input_file_index ) != "None":
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
6 ln -s -f "${inp.input}" "input_file_${i}.${inp.input.ext}" &amp;&amp;
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
7 ln -s -f "${inp.input_file_index}" "input_file_${i}.${inp.input.ext}.tbi" &amp;&amp;
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
8 #end if
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
9 #end for
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
10 /Volumes/drive2/galaxy/dist/tools/bcftools/bcftools merge
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
11 --output "${output_file}"
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
12 --output-type "${output_type}"
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
13 #if str( $regions_file ) != "None":
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
14 --regions-file "${regions_file}"
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
15 #end if
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
16 #if str( $regions ) != "":
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
17 --regions "${regions}"
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
18 #end if
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
19 ${force_samples}
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
20 #if str( $info_rules ) != "":
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
21 --info-rules "${info_rules}"
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
22 #end if
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
23 #if str( $merge ) != "None":
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
24 --merge "${merge}"
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
25 #end if
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
26
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
27 #for $i, $inp in enumerate( $inputs ):
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
28 #if str( $inp.input_file_index ) != "None":
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
29 "input_file_${i}.${inp.input.ext}"
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
30 #else
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
31 "${inp.input}"
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
32 #end if
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
33 #end for
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
34 </command>
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
35 <inputs>
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
36 <repeat name="inputs" title="Input files to merge" default="2" min="2">
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
37 <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."/>
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
38 <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."/>
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
39 </repeat>
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
40 <param name="output_type" type="select" label="Output data type" help="-O">
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
41 <option value="v" selected="true">VCF</option>
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
42 <option value="b">BCF</option>
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
43 </param>
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
44 <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."/>
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
45 <param name="regions" type="text" optional="True" label="Regions list" help="-r. Comma-separated list of regions. Format: chr|chr:pos|chr:from-to|chr:from-[,...]">
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
46 <sanitizer invalid_char="">
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
47 <valid initial="string.digits"><add value="CHRchr-:,"/> </valid>
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
48 </sanitizer>
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
49 </param>
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
50 <param name="info_rules" type="text" 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." />
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
51 <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." />
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
52 <param name="merge" type="select" optional="True" label="Multiallelic record types" help="-m. Control what types of multiallelic records can be created.">
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
53 <option value="none">None (Output multiple records instead of multiallelic records)</option>
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
54 <option value="snps">SNPs (Allow multiallelic SNP records)</option>
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
55 <option value="indels">Indels (Allow multiallelic indel records)</option>
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
56 <option value="both">Both (Allow both SNP and indel multiallelic records)</option>
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
57 <option value="all">All (Allow SNP records to be merged with indel records)</option>
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
58 <option value="id">ID (Merge by ID)</option>
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
59 </param>
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
60 </inputs>
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
61 <outputs>
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
62 <data name="output_file" format="vcf" label="${tool.name} on ${on_string}">
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
63 <change_format>
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
64 <when input="output_type" value="b" format="bcf" />
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
65 </change_format>
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
66 </data>
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
67 </outputs>
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
68 <help>
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
69 **About this tool**
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
70
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
71 **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.
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
72
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
73 Please see https://samtools.github.io/bcftools/bcftools.html for more info on options.
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
74 </help>
2cffdec901f5 Uploaded
wrtz
parents:
diff changeset
75 </tool>