annotate snpSift_rmInfo.xml @ 4:baf6602903e1

Uploaded
author jjohnson
date Wed, 09 Dec 2015 14:03:26 -0500
parents 49b5bd3dc316
children 2f40467536cf
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4
baf6602903e1 Uploaded
jjohnson
parents: 2
diff changeset
1 <tool id="snpSift_rmInfo" name="SnpSift rmInfo" version="@WRAPPER_VERSION@.0">
2
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 <macros>
4
baf6602903e1 Uploaded
jjohnson
parents: 2
diff changeset
4 <import>snpSift_macros.xml</import>
2
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
5 </macros>
4
baf6602903e1 Uploaded
jjohnson
parents: 2
diff changeset
6 <expand macro="requirements" />
baf6602903e1 Uploaded
jjohnson
parents: 2
diff changeset
7 <expand macro="stdio" />
baf6602903e1 Uploaded
jjohnson
parents: 2
diff changeset
8 <expand macro="version_command" />
baf6602903e1 Uploaded
jjohnson
parents: 2
diff changeset
9 <command><![CDATA[
2
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
10 java -Xmx2G -jar \$SNPEFF_JAR_PATH/SnpSift.jar rmInfo $input ' '.join($info_fields.split(',')) > $output
4
baf6602903e1 Uploaded
jjohnson
parents: 2
diff changeset
11 ]]>
2
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
12 </command>
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
13 <inputs>
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
14 <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
15 <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
16 <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
17 <validator type="empty_field" />
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
18 </param>
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
19 </inputs>
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
20 <outputs>
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
21 <data format="vcf" name="output" />
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
22 </outputs>
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
23 <tests>
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
24 <test>
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
25 <param name="input" ftype="vcf" value="test-data/test_rmInfo.vcf"/>
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
26 <param name="info_fields" value="EFF"/>
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
27 <output name="output">
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
28 <assert_contents>
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
29 <has_text text="DP=29" />
4
baf6602903e1 Uploaded
jjohnson
parents: 2
diff changeset
30 <not_has_text text="EFF=EXON" />
baf6602903e1 Uploaded
jjohnson
parents: 2
diff changeset
31 </assert_contents>
2
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
32 </output>
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
33 </test>
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
34 <test>
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
35 <param name="input" ftype="vcf" value="test-data/test_rmInfo.vcf"/>
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
36 <param name="info_fields" value="EFF"/>
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
37 <output name="output">
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
38 <assert_contents>
4
baf6602903e1 Uploaded
jjohnson
parents: 2
diff changeset
39 <not_has_text text="DP=29;EFF=EXON" />
baf6602903e1 Uploaded
jjohnson
parents: 2
diff changeset
40 </assert_contents>
2
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
41 </output>
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
42 </test>
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
43 </tests>
4
baf6602903e1 Uploaded
jjohnson
parents: 2
diff changeset
44 <help><![CDATA[
2
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
45 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
46
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
47 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
48
4
baf6602903e1 Uploaded
jjohnson
parents: 2
diff changeset
49 SnpEff & 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.
2
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
50 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
51
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
52 @EXTERNAL_DOCUMENTATION@
4
baf6602903e1 Uploaded
jjohnson
parents: 2
diff changeset
53 http://snpeff.sourceforge.net/SnpSift.html#rmInfo
2
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 @CITATION_SECTION@
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
56
4
baf6602903e1 Uploaded
jjohnson
parents: 2
diff changeset
57 ]]>
2
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
58 </help>
49b5bd3dc316 Add rmInfo tool
Jim Johnson <jj@umn.edu>
parents:
diff changeset
59 </tool>