annotate snpSift_rmInfo.xml @ 0:f0faaa4d6ee5 draft

Uploaded
author iuc
date Mon, 06 Apr 2015 15:47:15 -0400
parents
children b884686a80dc
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
f0faaa4d6ee5 Uploaded
iuc
parents:
diff changeset
1 <tool id="snpSift_rmInfo" name="SnpSift rmInfo" version="4.0.0">
f0faaa4d6ee5 Uploaded
iuc
parents:
diff changeset
2 <description>remove INFO field annotations</description>
f0faaa4d6ee5 Uploaded
iuc
parents:
diff changeset
3 <expand macro="requirements" />
f0faaa4d6ee5 Uploaded
iuc
parents:
diff changeset
4 <macros>
f0faaa4d6ee5 Uploaded
iuc
parents:
diff changeset
5 <import>snpSift_macros.xml</import>
f0faaa4d6ee5 Uploaded
iuc
parents:
diff changeset
6 </macros>
f0faaa4d6ee5 Uploaded
iuc
parents:
diff changeset
7 <command>
f0faaa4d6ee5 Uploaded
iuc
parents:
diff changeset
8 java -Xmx2G -jar \$SNPEFF_JAR_PATH/SnpSift.jar rmInfo $input ' '.join($info_fields.split(',')) > $output
f0faaa4d6ee5 Uploaded
iuc
parents:
diff changeset
9 </command>
f0faaa4d6ee5 Uploaded
iuc
parents:
diff changeset
10 <inputs>
f0faaa4d6ee5 Uploaded
iuc
parents:
diff changeset
11 <param format="vcf" name="input" type="data" label="Variant input file in VCF format"/>
f0faaa4d6ee5 Uploaded
iuc
parents:
diff changeset
12 <param name="info_fields" type="text" value="" label="Info fields to remove, e.g. EFF">
f0faaa4d6ee5 Uploaded
iuc
parents:
diff changeset
13 <help>Separate multiple INFO fields with a comma, e.g.: EFF,DP</help>
f0faaa4d6ee5 Uploaded
iuc
parents:
diff changeset
14 <validator type="empty_field" />
f0faaa4d6ee5 Uploaded
iuc
parents:
diff changeset
15 </param>
f0faaa4d6ee5 Uploaded
iuc
parents:
diff changeset
16 </inputs>
f0faaa4d6ee5 Uploaded
iuc
parents:
diff changeset
17 <outputs>
f0faaa4d6ee5 Uploaded
iuc
parents:
diff changeset
18 <data format="vcf" name="output" />
f0faaa4d6ee5 Uploaded
iuc
parents:
diff changeset
19 </outputs>
f0faaa4d6ee5 Uploaded
iuc
parents:
diff changeset
20 <expand macro="stdio" />
f0faaa4d6ee5 Uploaded
iuc
parents:
diff changeset
21 <tests>
f0faaa4d6ee5 Uploaded
iuc
parents:
diff changeset
22 <test>
f0faaa4d6ee5 Uploaded
iuc
parents:
diff changeset
23 <param name="input" ftype="vcf" value="test-data/test_rmInfo.vcf"/>
f0faaa4d6ee5 Uploaded
iuc
parents:
diff changeset
24 <param name="info_fields" value="EFF"/>
f0faaa4d6ee5 Uploaded
iuc
parents:
diff changeset
25 <output name="output">
f0faaa4d6ee5 Uploaded
iuc
parents:
diff changeset
26 <assert_contents>
f0faaa4d6ee5 Uploaded
iuc
parents:
diff changeset
27 <has_text text="DP=29" />
f0faaa4d6ee5 Uploaded
iuc
parents:
diff changeset
28 <not_has_text text="EFF=EXON" />
f0faaa4d6ee5 Uploaded
iuc
parents:
diff changeset
29 </assert_contents>
f0faaa4d6ee5 Uploaded
iuc
parents:
diff changeset
30 </output>
f0faaa4d6ee5 Uploaded
iuc
parents:
diff changeset
31 </test>
f0faaa4d6ee5 Uploaded
iuc
parents:
diff changeset
32 <test>
f0faaa4d6ee5 Uploaded
iuc
parents:
diff changeset
33 <param name="input" ftype="vcf" value="test-data/test_rmInfo.vcf"/>
f0faaa4d6ee5 Uploaded
iuc
parents:
diff changeset
34 <param name="info_fields" value="EFF"/>
f0faaa4d6ee5 Uploaded
iuc
parents:
diff changeset
35 <output name="output">
f0faaa4d6ee5 Uploaded
iuc
parents:
diff changeset
36 <assert_contents>
f0faaa4d6ee5 Uploaded
iuc
parents:
diff changeset
37 <not_has_text text="DP=29;EFF=EXON" />
f0faaa4d6ee5 Uploaded
iuc
parents:
diff changeset
38 </assert_contents>
f0faaa4d6ee5 Uploaded
iuc
parents:
diff changeset
39 </output>
f0faaa4d6ee5 Uploaded
iuc
parents:
diff changeset
40 </test>
f0faaa4d6ee5 Uploaded
iuc
parents:
diff changeset
41 </tests>
f0faaa4d6ee5 Uploaded
iuc
parents:
diff changeset
42 <help>
f0faaa4d6ee5 Uploaded
iuc
parents:
diff changeset
43 This command removes INFO fields from a VCF file (i.e. removes annotations)
f0faaa4d6ee5 Uploaded
iuc
parents:
diff changeset
44
f0faaa4d6ee5 Uploaded
iuc
parents:
diff changeset
45 Removing INFO fields is usually done because you want to re-annotate the VCF file, thus removing old INFO fields in order to add new ones later.
f0faaa4d6ee5 Uploaded
iuc
parents:
diff changeset
46
f0faaa4d6ee5 Uploaded
iuc
parents:
diff changeset
47 SnpEff &amp; SnpSift only add annotations and do not change current ones. So, in order to re-annotate a file, you should first remove the old annotations and then re-annotate.
f0faaa4d6ee5 Uploaded
iuc
parents:
diff changeset
48 The reason for this behavior is simply because replacing annotation values is considered a bad practice. Imagine that you have a VCF entry in your re-annotated file having the value "AA=1": How do you know if this is from the old annotations or from the new ones? This confusion often leads to problems in downstream steps of your pipelines, so it's better to avoid the problem by first removing all the previous annotations and then adding the new ones.
f0faaa4d6ee5 Uploaded
iuc
parents:
diff changeset
49
f0faaa4d6ee5 Uploaded
iuc
parents:
diff changeset
50 @EXTERNAL_DOCUMENTATION@
f0faaa4d6ee5 Uploaded
iuc
parents:
diff changeset
51 http://snpeff.sourceforge.net/SnpSift.html#rmInfo
f0faaa4d6ee5 Uploaded
iuc
parents:
diff changeset
52
f0faaa4d6ee5 Uploaded
iuc
parents:
diff changeset
53 @CITATION_SECTION@
f0faaa4d6ee5 Uploaded
iuc
parents:
diff changeset
54
f0faaa4d6ee5 Uploaded
iuc
parents:
diff changeset
55 </help>
f0faaa4d6ee5 Uploaded
iuc
parents:
diff changeset
56 </tool>