annotate vcftools.xml @ 14:eee5a6d6c440 draft default tip

Uploaded
author nilesh
date Wed, 10 Jul 2013 17:52:38 -0400
parents 136a34b6bdfc
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
12
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
1 <tool id="vcftools" name="VCFtools" version="0.0.1">
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
2 <description>
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
3 The vcftools program is intended for analysis of diploid SNP data in VCF format.
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
4 </description>
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
5 <requirements>
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
6 <requirement type="package" version="0.1.11">vcftools</requirement>
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
7 </requirements>
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
8 <command>
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
9 vcftools
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
10
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
11 #if str($basic) == "gzvcf"
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
12 --gzvcf
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
13 #elif str($basic) == "bcf"
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
14 --bcf
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
15 #else
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
16 --vcf
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
17 #end if
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
18
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
19 $input
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
20
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
21 #for $chromosome in $chr
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
22 --chr $chromosome.number
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
23 #end for
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
24
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
25 #for $chromosome in $notchr
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
26 --notchr $chromosome.number
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
27 #end for
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
28
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
29 #if str($frombp) != ""
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
30 --from-bp $frombp
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
31 #end if
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
32
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
33 #if str($tobp) != ""
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
34 --to-bp $tobp
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
35 #end if
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
36
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
37 #for $snp in $snps
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
38 --snp $snp.id
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
39 #end for
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
40
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
41 #if str(${snpfile.file_name}) != ""
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
42 --snps $snpfile
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
43 #end if
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
44
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
45 #if str(${excludesnpfile.file_name}) != ""
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
46 --snps $excludesnpfile
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
47 #end if
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
48
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
49 #if str($indels) == "keeponlyindels"
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
50 --keep-only-indels
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
51 #elif str($indels) == "removeindels"
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
52 --removeindels
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
53 #end if
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
54
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
55 $removefilterall $recodetostream > out.recode.vcf
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
56 </command>
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
57 <inputs>
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
58 <param name="input" type="data" label="Input vcf file" format="vcf" />
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
59 <param name="basic" type="select" label="Basic Options" value="vcf">
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
60 <option value="vcf">Decompressed vcf file (default)</option>
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
61 <option value="gzvcf">Compressed (gzipped) vcf file</option>
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
62 <option value="bcf">Compressed (bgzf) bcf file</option>
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
63 </param>
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
64 <repeat name="chr" title="Include chromosomes to be processed">
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
65 <param name="number" label="Chromosome number" type="integer" optional="true" />
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
66 </repeat>
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
67 <repeat name="notchr" title="Exclude chromosomes from processing">
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
68 <param name="number" label="Chromosome number" type="integer" optional="true" />
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
69 </repeat>
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
70 <param name="frombp" label="Beginning of range to be processed" help="only if chromosomes are included. You must also specify the end of range to be processed." optional="true" type="integer"/>
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
71 <param name="tobp" label="End of range to be processed" optional="true" type="integer" help="only if chromosomes are included. You must also specify the beginning of range to be processed."/>
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
72 <repeat name="snps" title="SNPs to include">
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
73 <param name="id" label="ID of SNP" type="text" optional="true" help="e.g. a dbSNP rsID"/>
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
74 </repeat>
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
75 <param name="snpfile" type="data" format="txt, tabular" label="List of SNPs to include" help="The file should contain a list of SNP IDs (e.g. dbSNP rsIDs), with one ID per line." optional="true"/>
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
76 <param name="excludesnpfile" type="data" label = "List of SNPs to disclude" format="txt, tabular" help="The file should contain a list of SNP IDs (e.g. dbSNP rsIDs), with one ID per line." optional="true"/>
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
77 <param name="indels" type="select" label="Indel options" value="none">
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
78 <option value="keeponlyindels">Keep only indels</option>
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
79 <option value="none">None</option>
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
80 <option value="removeindels"> Remove indels</option>
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
81 </param>
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
82 <param name="removefilterall" type="boolean" truevalue="--remove-filtered-all" falsevalue="" label="Remove all sites with the FILTER tag" value="false" />
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
83 <param name="recodetostream" type="boolean" truevalue="--recode-to-stream" falsevalue="" label="Recode to stream" value="false" />
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
84 </inputs>
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
85 <outputs>
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
86 <data format="vcf" name="output" from_work_dir="out.recode.vcf" />
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
87 </outputs>
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
88 <help>
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
89 Welcome to VCFtools - a program package designed for working with VCF files, such as those generated by the 1000 Genomes Project. The aim of VCFtools is to provide methods for working with VCF files: validating, merging, comparing and calculate some basic population genetic statistics. More information at http://vcftools.sourceforge.net/index.html.
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
90 </help>
136a34b6bdfc Uploaded
nilesh
parents:
diff changeset
91 </tool>