annotate snpSift_annotate.xml @ 9:937367efb1da default tip

Change tool dependency to package_snpeff_3_2, now uses environment variable: SNPEFF_JAR_PATH for the location of snpeff jar files.
author Jim Johnson <jj@umn.edu>
date Wed, 18 Sep 2013 10:49:56 -0500
parents 13b6ad2ddace
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 5
diff changeset
1 <tool id="snpSift_annotate" name="SnpSift Annotate" version="3.2">
0
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
2 <description>Annotate SNPs from dbSnp</description>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
3 <!--
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
4 You will need to change the path to wherever your installation is.
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
5 You can change the amount of memory used, just change the -Xmx parameter (e.g. use -Xmx2G for 2Gb of memory)
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
6 -->
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
7 <requirements>
8
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 5
diff changeset
8 <requirement type="package" version="3.2">snpEff</requirement>
0
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
9 </requirements>
8
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 5
diff changeset
10 <command>
9
937367efb1da Change tool dependency to package_snpeff_3_2, now uses environment variable: SNPEFF_JAR_PATH for the location of snpeff jar files.
Jim Johnson <jj@umn.edu>
parents: 8
diff changeset
11 java -Xmx6G -jar \$SNPEFF_JAR_PATH/SnpSift.jar $annotate_cmd
8
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 5
diff changeset
12 #if $annotate.id :
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 5
diff changeset
13 -id
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 5
diff changeset
14 #elif $annotate.info_ids.__str__.strip() != '' :
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 5
diff changeset
15 -info "$annotate.info_ids"
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 5
diff changeset
16 #end if
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 5
diff changeset
17 -q $dbSnp $input > $output
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 5
diff changeset
18 </command>
0
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
19 <inputs>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
20 <param format="vcf" name="input" type="data" label="VCF input"/>
8
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 5
diff changeset
21 <param format="vcf" name="dbSnp" type="data" label="VCF File with ID field annotated (e.g. dnSNP.vcf)"
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 5
diff changeset
22 help="The ID field for a variant in input will be assigned from a matching variant in this file."/>
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 5
diff changeset
23 <param name="annotate_cmd" type="boolean" truevalue="annMem" falsevalue="annotate" checked="false" label="Annotate in Memory"
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 5
diff changeset
24 help="allows unsorted VCF files, but it loads the entire 'database' VCF file into memory (which may not be practical for large 'database' VCF files)"/>
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 5
diff changeset
25 <conditional name="annotate">
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 5
diff changeset
26 <param name="id" type="boolean" truevalue="id" falsevalue="info" checked="True" label="Only annotate ID field (do not add INFO field)" help=""/>
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 5
diff changeset
27 <when value="id"/>
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 5
diff changeset
28 <when value="info">
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 5
diff changeset
29 <param name="info_ids" type="text" value="" optional="true" label="Limit INFO annotation to these INFO IDs"
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 5
diff changeset
30 help="list is a comma separated list of fields. When blank, all INFO fields are included">
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 5
diff changeset
31 <validator type="regex" message="IDs separted by commas">^(([a-zA-Z][a-zA-Z0-9_-]*)(,[a-zA-Z][a-zA-Z0-9_-]*)*)?$</validator>
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 5
diff changeset
32 </param>
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 5
diff changeset
33 </when>
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 5
diff changeset
34 </conditional>
0
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
35 </inputs>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
36 <stdio>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
37 <exit_code range=":-1" level="fatal" description="Error: Cannot open file" />
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
38 <exit_code range="1:" level="fatal" description="Error" />
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
39 </stdio>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
40
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
41 <outputs>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
42 <data format="vcf" name="output" />
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
43 </outputs>
5
192a236898f5 Add test cases for SnpSift
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
44 <tests>
192a236898f5 Add test cases for SnpSift
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
45 <test>
192a236898f5 Add test cases for SnpSift
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
46 <param name="input" ftype="vcf" value="annotate_1.vcf"/>
192a236898f5 Add test cases for SnpSift
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
47 <param name="dbSnp" ftype="vcf" value="db_test_1.vcf"/>
8
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 5
diff changeset
48 <param name="annotate_cmd" value="False"/>
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 5
diff changeset
49 <param name="id" value="True"/>
5
192a236898f5 Add test cases for SnpSift
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
50 <output name="output">
192a236898f5 Add test cases for SnpSift
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
51 <assert_contents>
192a236898f5 Add test cases for SnpSift
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
52 <has_text text="rs76166080" />
192a236898f5 Add test cases for SnpSift
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
53 </assert_contents>
192a236898f5 Add test cases for SnpSift
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
54 </output>
192a236898f5 Add test cases for SnpSift
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
55 </test>
192a236898f5 Add test cases for SnpSift
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
56 </tests>
0
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
57 <help>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
58
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
59 This is typically used to annotate IDs from dbSnp.
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
60
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
61 For details about this tool, please go to http://snpeff.sourceforge.net/SnpSift.html#annotate
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
62
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
63 </help>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
64 </tool>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
65