annotate vcfannotate.xml @ 0:87d916fbb7c4 draft

Uploaded
author devteam
date Thu, 19 Mar 2015 12:39:51 -0400
parents
children 829d46588cf5
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
87d916fbb7c4 Uploaded
devteam
parents:
diff changeset
1 <tool id="vcfannotate" name="VCFannotate:" version="0.0.3">
87d916fbb7c4 Uploaded
devteam
parents:
diff changeset
2 <description>Intersect VCF records with BED annotations</description>
87d916fbb7c4 Uploaded
devteam
parents:
diff changeset
3 <macros>
87d916fbb7c4 Uploaded
devteam
parents:
diff changeset
4 <import>macros.xml</import>
87d916fbb7c4 Uploaded
devteam
parents:
diff changeset
5 </macros>
87d916fbb7c4 Uploaded
devteam
parents:
diff changeset
6 <expand macro="requirements"></expand>
87d916fbb7c4 Uploaded
devteam
parents:
diff changeset
7 <expand macro="stdio" />
87d916fbb7c4 Uploaded
devteam
parents:
diff changeset
8 <command>vcfannotate --key "${key_option}" -b "${bed_data}" "${input}" > "${out_file1}"</command>
87d916fbb7c4 Uploaded
devteam
parents:
diff changeset
9 <inputs>
87d916fbb7c4 Uploaded
devteam
parents:
diff changeset
10 <param format="vcf" name="input" type="data" label="Select VCF dataset"/>
87d916fbb7c4 Uploaded
devteam
parents:
diff changeset
11 <param name="bed_data" type="data" format="bed" label="Select BED dataset to itersect with"/>
87d916fbb7c4 Uploaded
devteam
parents:
diff changeset
12 <param name="key_option" size="20" type="text" value="BED-features" label="Intersecting VCF records will be prefixed with this TAG within the INFO field" help="--key option"/>
87d916fbb7c4 Uploaded
devteam
parents:
diff changeset
13 </inputs>
87d916fbb7c4 Uploaded
devteam
parents:
diff changeset
14 <outputs>
87d916fbb7c4 Uploaded
devteam
parents:
diff changeset
15 <data format="vcf" name="out_file1" />
87d916fbb7c4 Uploaded
devteam
parents:
diff changeset
16 </outputs>
87d916fbb7c4 Uploaded
devteam
parents:
diff changeset
17 <tests>
87d916fbb7c4 Uploaded
devteam
parents:
diff changeset
18 <test>
87d916fbb7c4 Uploaded
devteam
parents:
diff changeset
19 <param name="bed_data" value="vcfannotate.bed" ftype="bed"/>
87d916fbb7c4 Uploaded
devteam
parents:
diff changeset
20 <param name="key_option" value="BED-features"/>
87d916fbb7c4 Uploaded
devteam
parents:
diff changeset
21 <param name="input" value="vcflib.vcf"/>
87d916fbb7c4 Uploaded
devteam
parents:
diff changeset
22 <output name="out_file1" file="vcfannotate-test1.vcf" lines_diff="2" />
87d916fbb7c4 Uploaded
devteam
parents:
diff changeset
23 </test>
87d916fbb7c4 Uploaded
devteam
parents:
diff changeset
24 </tests>
87d916fbb7c4 Uploaded
devteam
parents:
diff changeset
25 <help>
87d916fbb7c4 Uploaded
devteam
parents:
diff changeset
26
87d916fbb7c4 Uploaded
devteam
parents:
diff changeset
27 Intersect the records in the VCF file with intervals (features) provided in a BED file. Intersections are done on the reference sequences in the VCF file.
87d916fbb7c4 Uploaded
devteam
parents:
diff changeset
28
87d916fbb7c4 Uploaded
devteam
parents:
diff changeset
29 -----
87d916fbb7c4 Uploaded
devteam
parents:
diff changeset
30
87d916fbb7c4 Uploaded
devteam
parents:
diff changeset
31 .. class:: infomark
87d916fbb7c4 Uploaded
devteam
parents:
diff changeset
32
87d916fbb7c4 Uploaded
devteam
parents:
diff changeset
33
87d916fbb7c4 Uploaded
devteam
parents:
diff changeset
34 **Example**:
87d916fbb7c4 Uploaded
devteam
parents:
diff changeset
35
87d916fbb7c4 Uploaded
devteam
parents:
diff changeset
36 The following VCF line::
87d916fbb7c4 Uploaded
devteam
parents:
diff changeset
37
87d916fbb7c4 Uploaded
devteam
parents:
diff changeset
38 #CHROM POS ID REF ALT QUAL FILTER INFO FORMAT NA00001 NA00002 NA00003
87d916fbb7c4 Uploaded
devteam
parents:
diff changeset
39 20 1110696 rs6040355 A G,T 67 PASS NS=2;DP=10;AF=0.333,0.667;AA=T;DB GT:GQ:DP:HQ 1|2:21:6:23,27 2|1:2:0:18,2 2/2:35:4:.,.
87d916fbb7c4 Uploaded
devteam
parents:
diff changeset
40
87d916fbb7c4 Uploaded
devteam
parents:
diff changeset
41 will appear as the follwing after intersectuion with BED records uc010zpo.2, uc002wel.4, uc010zpp.2, and uc002wen::
87d916fbb7c4 Uploaded
devteam
parents:
diff changeset
42
87d916fbb7c4 Uploaded
devteam
parents:
diff changeset
43 #CHROM POS ID REF ALT QUAL FILTER INFO FORMAT NA00001 NA00002 NA00003
87d916fbb7c4 Uploaded
devteam
parents:
diff changeset
44 20 1110696 rs6040355 A G,T 67 PASS AA=T;AF=0.333,0.667;BED-features=uc010zpo.2:uc002wel.4:uc010zpp.2:uc002wen.4;DP=10;NS=2;DB GT:GQ:DP:HQ 1|2:21:6:23,27 2|1:2:0:18,2 2/2:35:4:.,.
87d916fbb7c4 Uploaded
devteam
parents:
diff changeset
45
87d916fbb7c4 Uploaded
devteam
parents:
diff changeset
46 ----
87d916fbb7c4 Uploaded
devteam
parents:
diff changeset
47
87d916fbb7c4 Uploaded
devteam
parents:
diff changeset
48 Vcfannotate @IS_PART_OF_VCFLIB@
87d916fbb7c4 Uploaded
devteam
parents:
diff changeset
49 </help>
87d916fbb7c4 Uploaded
devteam
parents:
diff changeset
50 <expand macro="citations" />
87d916fbb7c4 Uploaded
devteam
parents:
diff changeset
51 </tool>