annotate bcftools_view.xml @ 1:8ec355ee3bc1 draft

Uploaded
author iuc
date Thu, 14 Aug 2014 11:52:12 -0400
parents d4ab3121553d
children 5f9ba601748e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
8ec355ee3bc1 Uploaded
iuc
parents: 0
diff changeset
1 <tool id="bcftools_@EXECUTABLE@" name="bcftools @EXECUTABLE@" version="0.1.19.0">
0
d4ab3121553d Uploaded
iuc
parents:
diff changeset
2 <description>Convert, filter, subset VCF/BCF files</description>
d4ab3121553d Uploaded
iuc
parents:
diff changeset
3 <expand macro="requirements" />
d4ab3121553d Uploaded
iuc
parents:
diff changeset
4 <expand macro="version_command" />
d4ab3121553d Uploaded
iuc
parents:
diff changeset
5 <expand macro="stdio" />
d4ab3121553d Uploaded
iuc
parents:
diff changeset
6 <macros>
d4ab3121553d Uploaded
iuc
parents:
diff changeset
7 <token name="@EXECUTABLE@">bcftools</token>
d4ab3121553d Uploaded
iuc
parents:
diff changeset
8 <import>bcftools_macros.xml</import>
d4ab3121553d Uploaded
iuc
parents:
diff changeset
9 </macros>
d4ab3121553d Uploaded
iuc
parents:
diff changeset
10 <command>
d4ab3121553d Uploaded
iuc
parents:
diff changeset
11 @EXECUTABLE@ view
d4ab3121553d Uploaded
iuc
parents:
diff changeset
12 $A
d4ab3121553d Uploaded
iuc
parents:
diff changeset
13 $varsitesonly
d4ab3121553d Uploaded
iuc
parents:
diff changeset
14 $snpcalling
d4ab3121553d Uploaded
iuc
parents:
diff changeset
15 ##$F
d4ab3121553d Uploaded
iuc
parents:
diff changeset
16 $G
d4ab3121553d Uploaded
iuc
parents:
diff changeset
17 $N
d4ab3121553d Uploaded
iuc
parents:
diff changeset
18 $e
d4ab3121553d Uploaded
iuc
parents:
diff changeset
19 $g
d4ab3121553d Uploaded
iuc
parents:
diff changeset
20
d4ab3121553d Uploaded
iuc
parents:
diff changeset
21 #if str( $output_format ) == "bcf":
d4ab3121553d Uploaded
iuc
parents:
diff changeset
22 -b
d4ab3121553d Uploaded
iuc
parents:
diff changeset
23 #end if
d4ab3121553d Uploaded
iuc
parents:
diff changeset
24
d4ab3121553d Uploaded
iuc
parents:
diff changeset
25 -D $seq_dict
d4ab3121553d Uploaded
iuc
parents:
diff changeset
26
d4ab3121553d Uploaded
iuc
parents:
diff changeset
27 -i $ratio
d4ab3121553d Uploaded
iuc
parents:
diff changeset
28 -t $rate
d4ab3121553d Uploaded
iuc
parents:
diff changeset
29
d4ab3121553d Uploaded
iuc
parents:
diff changeset
30 $input
d4ab3121553d Uploaded
iuc
parents:
diff changeset
31 &gt; $output
d4ab3121553d Uploaded
iuc
parents:
diff changeset
32
d4ab3121553d Uploaded
iuc
parents:
diff changeset
33 </command>
d4ab3121553d Uploaded
iuc
parents:
diff changeset
34 <inputs>
d4ab3121553d Uploaded
iuc
parents:
diff changeset
35 <param name="input" type="data" format="bcf,vcf" label="Choose a bcf file to view" />
d4ab3121553d Uploaded
iuc
parents:
diff changeset
36 <param name="output_format" type="select" label="Choose the output format" help="-b">
d4ab3121553d Uploaded
iuc
parents:
diff changeset
37 <option value="vcf" selected="true">VCF</option>
d4ab3121553d Uploaded
iuc
parents:
diff changeset
38 <option value="bcf">BCF</option>
d4ab3121553d Uploaded
iuc
parents:
diff changeset
39 </param>
d4ab3121553d Uploaded
iuc
parents:
diff changeset
40
d4ab3121553d Uploaded
iuc
parents:
diff changeset
41 <param name="seq_dict" type="data" format="tabular" optional="True" label="List of chromosome names for conversion" help="(-D)" />
d4ab3121553d Uploaded
iuc
parents:
diff changeset
42
d4ab3121553d Uploaded
iuc
parents:
diff changeset
43 <param name="ratio" type="float" label="Use alternate INDEL-to-SNP mutation rate" value="-1" help="defaults to 0.15 (-i)" />
d4ab3121553d Uploaded
iuc
parents:
diff changeset
44 <param name="rate" type="float" label="Mutation rate for variant calling" value="0.001" help="default to 0.001 (-t)" />
d4ab3121553d Uploaded
iuc
parents:
diff changeset
45
d4ab3121553d Uploaded
iuc
parents:
diff changeset
46 <param name="A" type="boolean" truevalue="-A" falsevalue="" checked="False"
d4ab3121553d Uploaded
iuc
parents:
diff changeset
47 label="Retain all possible alternate alleles at variant sites" help="-A" />
d4ab3121553d Uploaded
iuc
parents:
diff changeset
48 <param name="varsitesonly" type="boolean" truevalue="-v" falsevalue="" checked="false" label="Output Potential Variant Sites Only" help="-v"/>
d4ab3121553d Uploaded
iuc
parents:
diff changeset
49 <param name="snpcalling" type="boolean" truevalue="-c" falsevalue="" checked="false" label="SNP calling" help="Forces -e the max-likelihood inference parameter. (-c)"/>
d4ab3121553d Uploaded
iuc
parents:
diff changeset
50 <!--param name="F" type="boolean" truevalue="-F" falsevalue="" checked="False"
d4ab3121553d Uploaded
iuc
parents:
diff changeset
51 label="Indicate PL is generated by r921 or before (ordering is different)" help="-F" /-->
d4ab3121553d Uploaded
iuc
parents:
diff changeset
52 <param name="G" type="boolean" truevalue="-G" falsevalue="" checked="False"
d4ab3121553d Uploaded
iuc
parents:
diff changeset
53 label="Suppress all individual genotype information" help="-G" />
d4ab3121553d Uploaded
iuc
parents:
diff changeset
54 <param name="N" type="boolean" truevalue="-N" falsevalue="" checked="False"
d4ab3121553d Uploaded
iuc
parents:
diff changeset
55 label="Skip sites where the REF field is not A/C/G/T" help="-N" />
d4ab3121553d Uploaded
iuc
parents:
diff changeset
56 <param name="e" type="boolean" truevalue="-e" falsevalue="" checked="False"
d4ab3121553d Uploaded
iuc
parents:
diff changeset
57 label="Perform max-likelihood inference only"
d4ab3121553d Uploaded
iuc
parents:
diff changeset
58 help="Including estimating the site allele frequency, testing Hardy-Weinberg equilibrium and testing associations with LRT. (-e)" />
d4ab3121553d Uploaded
iuc
parents:
diff changeset
59 <param name="g" type="boolean" truevalue="-g" falsevalue="" checked="True"
d4ab3121553d Uploaded
iuc
parents:
diff changeset
60 label="Call per-sample genotypes at variant sites" help="-g" />
d4ab3121553d Uploaded
iuc
parents:
diff changeset
61 </inputs>
d4ab3121553d Uploaded
iuc
parents:
diff changeset
62
d4ab3121553d Uploaded
iuc
parents:
diff changeset
63 <outputs>
d4ab3121553d Uploaded
iuc
parents:
diff changeset
64 <data format="bcf" name="output">
d4ab3121553d Uploaded
iuc
parents:
diff changeset
65 <change_format>
d4ab3121553d Uploaded
iuc
parents:
diff changeset
66 <when input="output_format" value="vcf" format="vcf" />
d4ab3121553d Uploaded
iuc
parents:
diff changeset
67 </change_format>
d4ab3121553d Uploaded
iuc
parents:
diff changeset
68 </data>
d4ab3121553d Uploaded
iuc
parents:
diff changeset
69 </outputs>
d4ab3121553d Uploaded
iuc
parents:
diff changeset
70
d4ab3121553d Uploaded
iuc
parents:
diff changeset
71 <tests>
d4ab3121553d Uploaded
iuc
parents:
diff changeset
72 </tests>
d4ab3121553d Uploaded
iuc
parents:
diff changeset
73
d4ab3121553d Uploaded
iuc
parents:
diff changeset
74 <help>
d4ab3121553d Uploaded
iuc
parents:
diff changeset
75 <![CDATA[
d4ab3121553d Uploaded
iuc
parents:
diff changeset
76 **BCFTools View**
d4ab3121553d Uploaded
iuc
parents:
diff changeset
77
d4ab3121553d Uploaded
iuc
parents:
diff changeset
78 VCF/BCF conversion, view, subset and filter VCF/BCF files.
d4ab3121553d Uploaded
iuc
parents:
diff changeset
79
d4ab3121553d Uploaded
iuc
parents:
diff changeset
80
d4ab3121553d Uploaded
iuc
parents:
diff changeset
81 **Input format**
d4ab3121553d Uploaded
iuc
parents:
diff changeset
82
d4ab3121553d Uploaded
iuc
parents:
diff changeset
83 `BCF files <http://www.1000genomes.org/wiki/analysis/variant-call-format/bcf-binary-vcf-version-2/>`_
d4ab3121553d Uploaded
iuc
parents:
diff changeset
84
d4ab3121553d Uploaded
iuc
parents:
diff changeset
85 ------
d4ab3121553d Uploaded
iuc
parents:
diff changeset
86
d4ab3121553d Uploaded
iuc
parents:
diff changeset
87 **Outputs**
d4ab3121553d Uploaded
iuc
parents:
diff changeset
88
d4ab3121553d Uploaded
iuc
parents:
diff changeset
89 VCF or BCF files
d4ab3121553d Uploaded
iuc
parents:
diff changeset
90
d4ab3121553d Uploaded
iuc
parents:
diff changeset
91 ]]>
d4ab3121553d Uploaded
iuc
parents:
diff changeset
92 </help>
d4ab3121553d Uploaded
iuc
parents:
diff changeset
93 <expand macro="citations"/>
d4ab3121553d Uploaded
iuc
parents:
diff changeset
94 </tool>