annotate snpSift_rmInfo.xml @ 3:1739678def32

Add vcfCheck and test cases
author Jim Johnson <jj@umn.edu>
date Thu, 23 Oct 2014 06:06:25 -0500
parents 49b5bd3dc316
children baf6602903e1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
1 <tool id="snpSift_rmInfo" name="SnpSift rmInfo" version="4.0.0">
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
2 <description>remove INFO field annotations</description>
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
3 <expand macro="requirements" />
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
4 <macros>
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
5 <import>snpEff_macros.xml</import>
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
6 </macros>
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
7 <command>
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
8 java -Xmx2G -jar \$SNPEFF_JAR_PATH/SnpSift.jar rmInfo $input ' '.join($info_fields.split(',')) > $output
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
9 </command>
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
10 <inputs>
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
11 <param format="vcf" name="input" type="data" label="Variant input file in VCF format"/>
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
12 <param name="info_fields" type="text" value="" label="Info fields to remove, e.g. EFF">
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
13 <help>Separate multiple INFO fields with a comma, e.g.: EFF,DP</help>
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
14 <validator type="empty_field" />
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
15 </param>
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
16 </inputs>
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
17 <outputs>
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
18 <data format="vcf" name="output" />
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
19 </outputs>
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
20 <expand macro="stdio" />
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
21 <tests>
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
22 <test>
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
23 <param name="input" ftype="vcf" value="test-data/test_rmInfo.vcf"/>
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
24 <param name="info_fields" value="EFF"/>
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
25 <output name="output">
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
26 <assert_contents>
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
27 <has_text text="DP=29" />
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
28 <not_has_text text="EFF=EXON" />
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
29 </assert_contents>
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
30 </output>
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
31 </test>
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
32 <test>
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
33 <param name="input" ftype="vcf" value="test-data/test_rmInfo.vcf"/>
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
34 <param name="info_fields" value="EFF"/>
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
35 <output name="output">
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
36 <assert_contents>
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
37 <not_has_text text="DP=29;EFF=EXON" />
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
38 </assert_contents>
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
39 </output>
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
40 </test>
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
41 </tests>
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
42 <help>
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
43 This command removes INFO fields from a VCF file (i.e. removes annotations)
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
44
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
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.
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
46
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
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.
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
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.
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
49
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
50 @EXTERNAL_DOCUMENTATION@
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
51 http://snpeff.sourceforge.net/SnpSift.html#rmInfo
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
52
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
53 @CITATION_SECTION@
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
54
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
55 </help>
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
56 </tool>