/tools/vcf_tools/annotate.xml

 1<tool id="vcf_annotate" name="Annotate" version="1.0.0">
 2  <description>a VCF file (dbSNP, hapmap)</description>
 3  <command interpreter="python">
 4    vcfPytools.py
 5      annotate 
 6      --in=$input1
 7      #if $annotation_options.annotate == "dbsnp"
 8      --dbsnp=$input2
 9      #elif $annotation_options.annotate == "hapmap"
10      --hapmap=$input2
11      #end if
12      --out=$output1
13  </command>
14  <inputs>
15    <param name="input1" label="VCF file to annotate" type="data" format="vcf" />
16    <conditional name="annotation_options">
17      <param name="annotate" type="select" label="annotation source">
18        <option value="dbsnp">dbSNP vcf file</option>
19        <option value="hapmap">hapmap vcf file</option>
20      </param>
21      <when value="dbsnp">
22        <param name="input2" label="dbSNP vcf file" type="data" format="vcf" help="This option will annotate the vcf file with dbSNP rsid values.  The input dbSNP file must also be in vcf v4.0 format.  Only dbSNP entries with VC=SNP are included."/>
23      </when>
24      <when value="hapmap">
25        <param name="input2" label="hapmap vcf file" type="data" format="vcf" help="This option will annotate the vcf file info string to include HM3 if the record is included hapmap.  If the ref/alt values do not match the hapmap file, the info string will be populated with HM3A."/>
26      </when>
27    </conditional>
28  </inputs>
29  <outputs>
30    <data format="vcf" name="output1" label="${tool.name} ${on_string}" />
31  </outputs>
32  <tests>
33    <test>
34      <param name="input1" value="test.small.vcf" ftype="vcf" />
35      <param name="annotate" value="dbsnp" />
36      <param name="input2" value="dbsnp.small.vcf" ftype="vcf" />
37      <output name="output" file="test_annotated_dbsnp.vcf" lines_diff="6" ftype="vcf" />
38    </test>
39    <test>
40      <param name="input1" value="test.small.vcf" ftype="vcf" />
41      <param name="annotate" value="hapmap" />
42      <param name="input2" value="hapmap.small.vcf" ftype="vcf" />
43      <output name="output" file="test_annotated_hapmap.vcf" lines_diff="6" ftype="vcf" />
44    </test>
45  </tests>
46  <help>
47
48**What it does**
49
50This tool uses vcfPytools_' annotate command annotate a VCF file
51
52.. _vcfPytools: https://github.com/AlistairNWard/vcfPytools
53
54Currently, either a hapmap or a dbsnp file should be provided, not both.
55
56dbSNP option will annotate the VCF file with dbSNP rsid values.  The input dbSNP file must also be in VCF v4.0 format.  Only dbSNP entries with VC=SNP are included.
57
58hapmap option will annotate the VCF file info string to include HM3 if the record is included hapmap.  If the ref/alt values do not match the hapmap file, the info string will be populated with HM3A.
59
60
61  </help>
62</tool>