annotate snpSift_caseControl.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: 6
diff changeset
1 <tool id="snpSift_caseControl" name="SnpSift CaseControl" version="3.2">
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 6
diff changeset
2 <description>Count samples are in 'case' and 'control' groups.</description>
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 6
diff changeset
3 <!--
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 6
diff changeset
4 You will need to change the path to wherever your installation is.
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 6
diff changeset
5 You can change the amount of memory used, just change the -Xmx parameter (e.g. use -Xmx2G for 2Gb of memory)
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 6
diff changeset
6 -->
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 6
diff changeset
7 <requirements>
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 6
diff changeset
8 <requirement type="package" version="3.2">snpEff</requirement>
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 6
diff changeset
9 </requirements>
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 6
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 -Xmx1G -jar \$SNPEFF_JAR_PATH/SnpSift.jar caseControl -q
8
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 6
diff changeset
12 #if $name.__str__.strip() != '':
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 6
diff changeset
13 -name $name
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 6
diff changeset
14 #end if
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 6
diff changeset
15 #if $ctrl.ctrl_src == 'caseString':
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 6
diff changeset
16 '$ctrl.caseControlStr'
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 6
diff changeset
17 #else
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 6
diff changeset
18 -tfam "$ctrl.tfam"
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 6
diff changeset
19 #end if
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 6
diff changeset
20 $input > $output
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 6
diff changeset
21 </command>
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 6
diff changeset
22 <inputs>
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 6
diff changeset
23 <param format="vcf" name="input" type="data" label="VCF input"/>
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 6
diff changeset
24 <conditional name="ctrl">
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 6
diff changeset
25 <param name="ctrl_src" type="select" label="Case Control defined in">
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 6
diff changeset
26 <option value="caseString">Case Control String</option>
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 6
diff changeset
27 <option value="tfam">TFAM</option>
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 6
diff changeset
28 </param>
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 6
diff changeset
29 <when value="caseString">
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 6
diff changeset
30 <param name="caseControlStr" type="text" label="Case / Control column designation" size="50">
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 6
diff changeset
31 <help>
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 6
diff changeset
32 Case and control are defined by a string containing plus and minus symbols {'+', '-', '0'} where '+' is case, '-' is control and '0' is neutral
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 6
diff changeset
33 </help>
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 6
diff changeset
34 <validator type="regex" message="must be only plus(+), minus(-), or zero(0) characters">[+-0]+</validator>
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 6
diff changeset
35 </param>
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 6
diff changeset
36 </when>
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 6
diff changeset
37 <when value="tfam">
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 6
diff changeset
38 <param format="tabular" name="tfam" type="data" label="PLINK TFAM file"/>
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 6
diff changeset
39 </when>
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 6
diff changeset
40 </conditional>
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 6
diff changeset
41 <param name="name" type="text" optional="true" label="name" help="name to append to the 'Cases' or 'Controls' tags">
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 6
diff changeset
42 <validator type="regex" message="Use only valid ID characters">[_a-zA-Z0-9]+</validator>
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 6
diff changeset
43 </param>
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 6
diff changeset
44 </inputs>
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 6
diff changeset
45 <outputs>
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 6
diff changeset
46 <data format="vcf" name="output" />
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 6
diff changeset
47 </outputs>
0
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
48 <stdio>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
49 <exit_code range=":-1" level="fatal" description="Error: Cannot open file" />
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
50 <exit_code range="1:" level="fatal" description="Error" />
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
51 </stdio>
5
192a236898f5 Add test cases for SnpSift
Jim Johnson <jj@umn.edu>
parents: 2
diff changeset
52 <tests>
192a236898f5 Add test cases for SnpSift
Jim Johnson <jj@umn.edu>
parents: 2
diff changeset
53
192a236898f5 Add test cases for SnpSift
Jim Johnson <jj@umn.edu>
parents: 2
diff changeset
54 <test>
192a236898f5 Add test cases for SnpSift
Jim Johnson <jj@umn.edu>
parents: 2
diff changeset
55 <param name="input" ftype="vcf" value="test.private.01.vcf"/>
8
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 6
diff changeset
56 <param name="ctrl_src" value="caseString"/>
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 6
diff changeset
57 <param name="caseControlStr" value="--"/>
5
192a236898f5 Add test cases for SnpSift
Jim Johnson <jj@umn.edu>
parents: 2
diff changeset
58 <output name="output">
192a236898f5 Add test cases for SnpSift
Jim Johnson <jj@umn.edu>
parents: 2
diff changeset
59 <assert_contents>
8
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 6
diff changeset
60 <has_text text="Cases=0,0,0;" />
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 6
diff changeset
61 <has_text text="Controls=0,0,0;" />
5
192a236898f5 Add test cases for SnpSift
Jim Johnson <jj@umn.edu>
parents: 2
diff changeset
62 </assert_contents>
192a236898f5 Add test cases for SnpSift
Jim Johnson <jj@umn.edu>
parents: 2
diff changeset
63 </output>
192a236898f5 Add test cases for SnpSift
Jim Johnson <jj@umn.edu>
parents: 2
diff changeset
64 </test>
192a236898f5 Add test cases for SnpSift
Jim Johnson <jj@umn.edu>
parents: 2
diff changeset
65
192a236898f5 Add test cases for SnpSift
Jim Johnson <jj@umn.edu>
parents: 2
diff changeset
66 <test>
192a236898f5 Add test cases for SnpSift
Jim Johnson <jj@umn.edu>
parents: 2
diff changeset
67 <param name="input" ftype="vcf" value="test.private.02.vcf"/>
8
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 6
diff changeset
68 <param name="ctrl_src" value="caseString"/>
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 6
diff changeset
69 <param name="caseControlStr" value="--"/>
5
192a236898f5 Add test cases for SnpSift
Jim Johnson <jj@umn.edu>
parents: 2
diff changeset
70 <output name="output">
192a236898f5 Add test cases for SnpSift
Jim Johnson <jj@umn.edu>
parents: 2
diff changeset
71 <assert_contents>
8
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 6
diff changeset
72 <has_text text="Cases=0,0,0;" />
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 6
diff changeset
73 <has_text text="Controls=2,0,4;" />
5
192a236898f5 Add test cases for SnpSift
Jim Johnson <jj@umn.edu>
parents: 2
diff changeset
74 </assert_contents>
192a236898f5 Add test cases for SnpSift
Jim Johnson <jj@umn.edu>
parents: 2
diff changeset
75 </output>
192a236898f5 Add test cases for SnpSift
Jim Johnson <jj@umn.edu>
parents: 2
diff changeset
76 </test>
192a236898f5 Add test cases for SnpSift
Jim Johnson <jj@umn.edu>
parents: 2
diff changeset
77
192a236898f5 Add test cases for SnpSift
Jim Johnson <jj@umn.edu>
parents: 2
diff changeset
78 <test>
192a236898f5 Add test cases for SnpSift
Jim Johnson <jj@umn.edu>
parents: 2
diff changeset
79 <param name="input" ftype="vcf" value="test.private.02.vcf"/>
8
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 6
diff changeset
80 <param name="name" value=""/>
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 6
diff changeset
81 <param name="ctrl_src" value="caseString"/>
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 6
diff changeset
82 <param name="caseControlStr" value="-+"/>
5
192a236898f5 Add test cases for SnpSift
Jim Johnson <jj@umn.edu>
parents: 2
diff changeset
83 <output name="output">
192a236898f5 Add test cases for SnpSift
Jim Johnson <jj@umn.edu>
parents: 2
diff changeset
84 <assert_contents>
8
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 6
diff changeset
85 <has_text text="Cases=1,0,2;" />
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 6
diff changeset
86 <has_text text="Controls=1,0,2;" />
5
192a236898f5 Add test cases for SnpSift
Jim Johnson <jj@umn.edu>
parents: 2
diff changeset
87 </assert_contents>
192a236898f5 Add test cases for SnpSift
Jim Johnson <jj@umn.edu>
parents: 2
diff changeset
88 </output>
192a236898f5 Add test cases for SnpSift
Jim Johnson <jj@umn.edu>
parents: 2
diff changeset
89 </test>
192a236898f5 Add test cases for SnpSift
Jim Johnson <jj@umn.edu>
parents: 2
diff changeset
90
192a236898f5 Add test cases for SnpSift
Jim Johnson <jj@umn.edu>
parents: 2
diff changeset
91 </tests>
0
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
92
8
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 6
diff changeset
93 <help>
0
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
94
1
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
95 **SnpSift CaseControl**
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
96
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
97 Allows you to count how many samples are in 'case' group and a 'control' group. You can count 'homozygous', 'heterozygous' or 'any' variants.
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
98
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
99 Case and control are defined by a string containing plus and minus symbols {'+', '-', '0'} where '+' is case, '-' is control and '0' is neutral.
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
100
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
101 This command adds two annotations to the VCF file:
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
102
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
103 - **CaseControl**: Two comma separated numbers numbers representing the number of samples that have the variant in the case and the control group. Example:
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
104
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
105 "CaseControl=3,4" *the variant is present in 3 cases and 4 controls.*
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
106
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
107
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
108 - **CaseControlP**: A p-value (Fisher exact test) that the number of cases is N or more. Example:
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
109
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
110 "CaseControl=4,0;CaseControlP=3.030303e-02" *in this case the pValue of having 4 or more cases and zero controls is 0.03*
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
111
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
112
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
113 For example, if we have ten samples (which means ten genotype columns in the VCF file), the first four are 'case' and the last six are 'control', so the description string would be "++++------". Let's say we want to distinguish genotypes that are homozygous in 'case' and either homozygous or heterozygous in 'control'. We would set:
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
114
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
115 - Hom/Het case = "hom"
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
116
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
117 - Hom/Het control = "any"
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
118
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
119 - Case / Control column designation = ""++++------"
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
120
0
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
121
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
122 For details about this tool, please go to http://snpeff.sourceforge.net/SnpSift.html#casecontrol
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
123
8
13b6ad2ddace SnpEffect v3.2
Jim Johnson <jj@umn.edu>
parents: 6
diff changeset
124 </help>
0
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
125 </tool>