annotate snpSift_caseControl.xml @ 1:2c595fea585c

Add more doocumentation
author Jim Johnson <jj@umn.edu>
date Wed, 30 Jan 2013 16:20:32 -0600
parents c07c403fc470
children a9bae7957c36
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
1 <tool id="snpSift_caseControl" name="SnpSift CaseControl" version="3.1">
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
2 <description>Count samples are in 'case' and 'control' groups.</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>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
8 <requirement type="package" version="3.1">snpEff</requirement>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
9 </requirements>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
10 <command>
1
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
11 java -Xmx1G -jar \$JAVA_JAR_PATH/SnpSift.jar casControl -q $hhCase $hhControl '$caseControStr' $input > $output
0
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
12 </command>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
13 <inputs>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
14 <param format="vcf" name="input" type="data" label="VCF input"/>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
15 <param name="hhCase" type="select" label="Hom/Het case">
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
16 <option value="any">Any</option>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
17 <option value="hom">Homozygous</option>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
18 <option value="het">Heterozygous</option>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
19 </param>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
20 <param name="hhControl" type="select" label="Hom/Het control">
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
21 <option value="any">Any</option>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
22 <option value="hom">Homozygous</option>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
23 <option value="het">Heterozygous</option>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
24 </param>
1
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
25 <param name="caseControStr" type="text" label="Case / Control column designation" size="50">
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
26 <help>
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
27 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
28 </help>
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
29 <validator type="regex" message="must be only plus(+), minus(-), or zero(0) characters">[+-0]+</validator>
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
30 </param>
0
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
31 </inputs>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
32 <outputs>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
33 <data format="vcf" name="output" />
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
34 </outputs>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
35 <stdio>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
36 <exit_code range=":-1" level="fatal" description="Error: Cannot open file" />
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
37 <exit_code range="1:" level="fatal" description="Error" />
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
38 </stdio>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
39
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
40 <help>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
41
1
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
42 **SnpSift CaseControl**
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
43
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
44 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
45
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
46 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
47
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
48 This command adds two annotations to the VCF file:
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
49
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
50 - **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
51
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
52 "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
53
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
54
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
55 - **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
56
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
57 "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
58
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
59
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
60 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
61
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
62 - Hom/Het case = "hom"
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
63
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
64 - Hom/Het control = "any"
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
65
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
66 - Case / Control column designation = ""++++------"
2c595fea585c Add more doocumentation
Jim Johnson <jj@umn.edu>
parents: 0
diff changeset
67
0
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
68
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
69 For details about this tool, please go to http://snpeff.sourceforge.net/SnpSift.html#casecontrol
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
70
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
71 </help>
c07c403fc470 Uploaded
jjohnson
parents:
diff changeset
72 </tool>