annotate snpSift_annotate.xml @ 2:bf8c1526871b draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpsift/snpsift commit d12355cea76843e3ed6f09d96c3e9fe22afe4a4f
author iuc
date Mon, 05 Dec 2016 12:11:18 -0500
parents 98708b88af9f
children 20c7d583fec1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
bf8c1526871b planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpsift/snpsift commit d12355cea76843e3ed6f09d96c3e9fe22afe4a4f
iuc
parents: 1
diff changeset
1 <tool id="snpSift_annotate" name="SnpSift Annotate" version="@WRAPPER_VERSION@.1">
0
9e8280e19338 Uploaded
iuc
parents:
diff changeset
2 <description>SNPs from dbSnp</description>
2
bf8c1526871b planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpsift/snpsift commit d12355cea76843e3ed6f09d96c3e9fe22afe4a4f
iuc
parents: 1
diff changeset
3 <!--
0
9e8280e19338 Uploaded
iuc
parents:
diff changeset
4 You can change the amount of memory used, just change the -Xmx parameter (e.g. use -Xmx2G for 2Gb of memory)
9e8280e19338 Uploaded
iuc
parents:
diff changeset
5 -->
9e8280e19338 Uploaded
iuc
parents:
diff changeset
6 <macros>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
7 <import>snpSift_macros.xml</import>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
8 </macros>
1
98708b88af9f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpsift/snpsift commit 21b46ae2c90ba7e569b2b3a9eaf938f8dedb2c31
iuc
parents: 0
diff changeset
9 <expand macro="requirements" />
98708b88af9f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpsift/snpsift commit 21b46ae2c90ba7e569b2b3a9eaf938f8dedb2c31
iuc
parents: 0
diff changeset
10 <expand macro="stdio" />
98708b88af9f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpsift/snpsift commit 21b46ae2c90ba7e569b2b3a9eaf938f8dedb2c31
iuc
parents: 0
diff changeset
11 <expand macro="version_command" />
98708b88af9f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpsift/snpsift commit 21b46ae2c90ba7e569b2b3a9eaf938f8dedb2c31
iuc
parents: 0
diff changeset
12 <command><![CDATA[
2
bf8c1526871b planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpsift/snpsift commit d12355cea76843e3ed6f09d96c3e9fe22afe4a4f
iuc
parents: 1
diff changeset
13 @CONDA_SNPSIFT_JAR_PATH@ &&
bf8c1526871b planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpsift/snpsift commit d12355cea76843e3ed6f09d96c3e9fe22afe4a4f
iuc
parents: 1
diff changeset
14 java -Xmx6G -jar "\$SNPSIFT_JAR_PATH/SnpSift.jar" $annotate_cmd
0
9e8280e19338 Uploaded
iuc
parents:
diff changeset
15 #if $annotate.id :
9e8280e19338 Uploaded
iuc
parents:
diff changeset
16 -id
1
98708b88af9f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpsift/snpsift commit 21b46ae2c90ba7e569b2b3a9eaf938f8dedb2c31
iuc
parents: 0
diff changeset
17 #elif str($annotate.info_ids).strip() != '' :
0
9e8280e19338 Uploaded
iuc
parents:
diff changeset
18 -info "$annotate.info_ids"
2
bf8c1526871b planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpsift/snpsift commit d12355cea76843e3ed6f09d96c3e9fe22afe4a4f
iuc
parents: 1
diff changeset
19 #end if
bf8c1526871b planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpsift/snpsift commit d12355cea76843e3ed6f09d96c3e9fe22afe4a4f
iuc
parents: 1
diff changeset
20 -q "$dbSnp" "$input" > "$output"
1
98708b88af9f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpsift/snpsift commit 21b46ae2c90ba7e569b2b3a9eaf938f8dedb2c31
iuc
parents: 0
diff changeset
21 ]]>
0
9e8280e19338 Uploaded
iuc
parents:
diff changeset
22 </command>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
23 <inputs>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
24 <param format="vcf" name="input" type="data" label="Variant input file in VCF format"/>
2
bf8c1526871b planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpsift/snpsift commit d12355cea76843e3ed6f09d96c3e9fe22afe4a4f
iuc
parents: 1
diff changeset
25 <param format="vcf" name="dbSnp" type="data" label="VCF File with ID field annotated (e.g. dnSNP.vcf)"
0
9e8280e19338 Uploaded
iuc
parents:
diff changeset
26 help="The ID field for a variant in input will be assigned from a matching variant in this file."/>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
27 <conditional name="annotate">
9e8280e19338 Uploaded
iuc
parents:
diff changeset
28 <param name="id" type="boolean" truevalue="id" falsevalue="info" checked="True" label="Only annotate ID field (do not add INFO field)" help=""/>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
29 <when value="id"/>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
30 <when value="info">
2
bf8c1526871b planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpsift/snpsift commit d12355cea76843e3ed6f09d96c3e9fe22afe4a4f
iuc
parents: 1
diff changeset
31 <param name="info_ids" type="text" value="" label="Limit INFO annotation to these INFO IDs" help="List is a comma separated list of fields. When blank, all INFO fields are included">
0
9e8280e19338 Uploaded
iuc
parents:
diff changeset
32 <validator type="regex" message="IDs separted by commas">^(([a-zA-Z][a-zA-Z0-9_-]*)(,[a-zA-Z][a-zA-Z0-9_-]*)*)?$</validator>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
33 </param>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
34 </when>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
35 </conditional>
2
bf8c1526871b planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpsift/snpsift commit d12355cea76843e3ed6f09d96c3e9fe22afe4a4f
iuc
parents: 1
diff changeset
36 <param name="annotate_cmd" type="boolean" truevalue="annMem" falsevalue="annotate" checked="false" label="Allow unsorted VCF files">
0
9e8280e19338 Uploaded
iuc
parents:
diff changeset
37 <help>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
38 This option will load the entire 'database' VCF file into memory (which may not be practical for large 'database' VCF files).
2
bf8c1526871b planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpsift/snpsift commit d12355cea76843e3ed6f09d96c3e9fe22afe4a4f
iuc
parents: 1
diff changeset
39 Otherwise, both the database and the input VCF files should be sorted by position (Chromosome sort order can differ between files).
0
9e8280e19338 Uploaded
iuc
parents:
diff changeset
40 </help>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
41 </param>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
42 </inputs>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
43 <outputs>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
44 <data format="vcf" name="output" />
9e8280e19338 Uploaded
iuc
parents:
diff changeset
45 </outputs>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
46 <tests>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
47 <test>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
48 <param name="input" ftype="vcf" value="annotate_1.vcf"/>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
49 <param name="dbSnp" ftype="vcf" value="db_test_1.vcf"/>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
50 <param name="annotate_cmd" value="False"/>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
51 <param name="id" value="True"/>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
52 <output name="output">
9e8280e19338 Uploaded
iuc
parents:
diff changeset
53 <assert_contents>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
54 <has_text text="rs76166080" />
9e8280e19338 Uploaded
iuc
parents:
diff changeset
55 </assert_contents>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
56 </output>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
57 </test>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
58 </tests>
1
98708b88af9f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpsift/snpsift commit 21b46ae2c90ba7e569b2b3a9eaf938f8dedb2c31
iuc
parents: 0
diff changeset
59 <help><![CDATA[
0
9e8280e19338 Uploaded
iuc
parents:
diff changeset
60
9e8280e19338 Uploaded
iuc
parents:
diff changeset
61 This is typically used to annotate IDs from dbSnp.
9e8280e19338 Uploaded
iuc
parents:
diff changeset
62
9e8280e19338 Uploaded
iuc
parents:
diff changeset
63 Annotatating only the ID field from dbSnp137.vcf ::
9e8280e19338 Uploaded
iuc
parents:
diff changeset
64
9e8280e19338 Uploaded
iuc
parents:
diff changeset
65 Input VCF:
9e8280e19338 Uploaded
iuc
parents:
diff changeset
66 CHROM POS ID REF ALT QUAL FILTER INFO
9e8280e19338 Uploaded
iuc
parents:
diff changeset
67 22 16157571 . T G 0.0 FAIL NS=53
9e8280e19338 Uploaded
iuc
parents:
diff changeset
68 22 16346045 . T C 0.0 FAIL NS=244
9e8280e19338 Uploaded
iuc
parents:
diff changeset
69 22 16350245 . C A 0.0 FAIL NS=192
9e8280e19338 Uploaded
iuc
parents:
diff changeset
70
9e8280e19338 Uploaded
iuc
parents:
diff changeset
71 Annotated Output VCF:
9e8280e19338 Uploaded
iuc
parents:
diff changeset
72 #CHROM POS ID REF ALT QUAL FILTER INFO
9e8280e19338 Uploaded
iuc
parents:
diff changeset
73 22 16157571 . T G 0.0 FAIL NS=53
9e8280e19338 Uploaded
iuc
parents:
diff changeset
74 22 16346045 rs56234788 T C 0.0 FAIL NS=244
9e8280e19338 Uploaded
iuc
parents:
diff changeset
75 22 16350245 rs2905295 C A 0.0 FAIL NS=192
9e8280e19338 Uploaded
iuc
parents:
diff changeset
76
9e8280e19338 Uploaded
iuc
parents:
diff changeset
77
9e8280e19338 Uploaded
iuc
parents:
diff changeset
78
9e8280e19338 Uploaded
iuc
parents:
diff changeset
79 Annotatating both the ID and INFO fields from dbSnp137.vcf ::
9e8280e19338 Uploaded
iuc
parents:
diff changeset
80
9e8280e19338 Uploaded
iuc
parents:
diff changeset
81 Input VCF:
9e8280e19338 Uploaded
iuc
parents:
diff changeset
82 #CHROM POS ID REF ALT QUAL FILTER INFO
9e8280e19338 Uploaded
iuc
parents:
diff changeset
83 22 16157571 . T G 0.0 FAIL NS=53
9e8280e19338 Uploaded
iuc
parents:
diff changeset
84 22 16346045 . T C 0.0 FAIL NS=244
9e8280e19338 Uploaded
iuc
parents:
diff changeset
85 22 16350245 . C A 0.0 FAIL NS=192
9e8280e19338 Uploaded
iuc
parents:
diff changeset
86
9e8280e19338 Uploaded
iuc
parents:
diff changeset
87 Annotated Output VCF:
9e8280e19338 Uploaded
iuc
parents:
diff changeset
88 #CHROM POS ID REF ALT QUAL FILTER INFO
9e8280e19338 Uploaded
iuc
parents:
diff changeset
89 22 16157571 . T G 0.0 FAIL NS=53
9e8280e19338 Uploaded
iuc
parents:
diff changeset
90 22 16346045 rs56234788 T C 0.0 FAIL NS=244;RSPOS=16346045;GMAF=0.162248628884826;dbSNPBuildID=129;SSR=0;SAO=0;VP=050100000000000100000100;WGT=0;VC=SNV;SLO;GNO
9e8280e19338 Uploaded
iuc
parents:
diff changeset
91 22 16350245 rs2905295 C A 0.0 FAIL NS=192;RSPOS=16350245;GMAF=0.230804387568556;dbSNPBuildID=101;SSR=1;SAO=0;VP=050000000000000100000140;WGT=0;VC=SNV;GNO
9e8280e19338 Uploaded
iuc
parents:
diff changeset
92
9e8280e19338 Uploaded
iuc
parents:
diff changeset
93
9e8280e19338 Uploaded
iuc
parents:
diff changeset
94 @EXTERNAL_DOCUMENTATION@
9e8280e19338 Uploaded
iuc
parents:
diff changeset
95 http://snpeff.sourceforge.net/SnpSift.html#annotate
9e8280e19338 Uploaded
iuc
parents:
diff changeset
96
1
98708b88af9f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpsift/snpsift commit 21b46ae2c90ba7e569b2b3a9eaf938f8dedb2c31
iuc
parents: 0
diff changeset
97 ]]>
0
9e8280e19338 Uploaded
iuc
parents:
diff changeset
98 </help>
1
98708b88af9f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpsift/snpsift commit 21b46ae2c90ba7e569b2b3a9eaf938f8dedb2c31
iuc
parents: 0
diff changeset
99 <expand macro="citations" />
0
9e8280e19338 Uploaded
iuc
parents:
diff changeset
100 </tool>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
101