annotate snpSift_caseControl.xml @ 0:9e8280e19338 draft

Uploaded
author iuc
date Thu, 22 Jan 2015 08:39:07 -0500
parents
children 98708b88af9f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
9e8280e19338 Uploaded
iuc
parents:
diff changeset
1 <tool id="snpSift_caseControl" name="SnpSift CaseControl" version="4.0.0">
9e8280e19338 Uploaded
iuc
parents:
diff changeset
2 <description>Count samples are in 'case' and 'control' groups.</description>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
3 <!--
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 <expand macro="requirements" />
9e8280e19338 Uploaded
iuc
parents:
diff changeset
7 <macros>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
8 <import>snpSift_macros.xml</import>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
9 </macros>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
10 <command>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
11 java -Xmx1G -jar \$SNPEFF_JAR_PATH/SnpSift.jar caseControl -q
9e8280e19338 Uploaded
iuc
parents:
diff changeset
12 #if $name.__str__.strip() != '':
9e8280e19338 Uploaded
iuc
parents:
diff changeset
13 -name $name
9e8280e19338 Uploaded
iuc
parents:
diff changeset
14 #end if
9e8280e19338 Uploaded
iuc
parents:
diff changeset
15 #if $ctrl.ctrl_src == 'caseString':
9e8280e19338 Uploaded
iuc
parents:
diff changeset
16 '$ctrl.caseControlStr'
9e8280e19338 Uploaded
iuc
parents:
diff changeset
17 #else
9e8280e19338 Uploaded
iuc
parents:
diff changeset
18 -tfam "$ctrl.tfam"
9e8280e19338 Uploaded
iuc
parents:
diff changeset
19 #end if
9e8280e19338 Uploaded
iuc
parents:
diff changeset
20 $input > $output
9e8280e19338 Uploaded
iuc
parents:
diff changeset
21 </command>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
22 <inputs>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
23 <param format="vcf" name="input" type="data" label="Variant input file in VCF format"/>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
24 <conditional name="ctrl">
9e8280e19338 Uploaded
iuc
parents:
diff changeset
25 <param name="ctrl_src" type="select" label="Case Control defined in">
9e8280e19338 Uploaded
iuc
parents:
diff changeset
26 <option value="caseString">Case Control String</option>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
27 <option value="tfam">TFAM file</option>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
28 </param>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
29 <when value="caseString">
9e8280e19338 Uploaded
iuc
parents:
diff changeset
30 <param name="caseControlStr" type="text" label="Case / Control column designation" size="50">
9e8280e19338 Uploaded
iuc
parents:
diff changeset
31 <help>
9e8280e19338 Uploaded
iuc
parents:
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
9e8280e19338 Uploaded
iuc
parents:
diff changeset
33 </help>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
34 <validator type="regex" message="must be only plus(+), minus(-), or zero(0) characters">[+-0]+</validator>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
35 </param>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
36 </when>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
37 <when value="tfam">
9e8280e19338 Uploaded
iuc
parents:
diff changeset
38 <param format="tabular" name="tfam" type="data" label="PLINK TFAM file" help="Read more about TFAM at http://pngu.mgh.harvard.edu/~purcell/plink/data.shtml#tr"/>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
39 </when>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
40 </conditional>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
41 <param name="name" type="text" optional="true" label="name" help="name to append to the 'Cases' or 'Controls' tags">
9e8280e19338 Uploaded
iuc
parents:
diff changeset
42 <validator type="regex" message="Use only valid ID characters">[_a-zA-Z0-9]+</validator>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
43 </param>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
44 </inputs>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
45 <outputs>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
46 <data format="vcf" name="output" />
9e8280e19338 Uploaded
iuc
parents:
diff changeset
47 </outputs>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
48 <expand macro="stdio" />
9e8280e19338 Uploaded
iuc
parents:
diff changeset
49 <tests>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
50 <test>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
51 <param name="input" ftype="vcf" value="test.private.01.vcf"/>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
52 <param name="ctrl_src" value="caseString"/>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
53 <param name="caseControlStr" value="--"/>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
54 <output name="output">
9e8280e19338 Uploaded
iuc
parents:
diff changeset
55 <assert_contents>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
56 <has_text text="Cases=0,0,0;" />
9e8280e19338 Uploaded
iuc
parents:
diff changeset
57 <has_text text="Controls=0,0,0;" />
9e8280e19338 Uploaded
iuc
parents:
diff changeset
58 </assert_contents>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
59 </output>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
60 </test>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
61
9e8280e19338 Uploaded
iuc
parents:
diff changeset
62 <test>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
63 <param name="input" ftype="vcf" value="test.private.02.vcf"/>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
64 <param name="ctrl_src" value="caseString"/>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
65 <param name="caseControlStr" value="--"/>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
66 <output name="output">
9e8280e19338 Uploaded
iuc
parents:
diff changeset
67 <assert_contents>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
68 <has_text text="Cases=0,0,0;" />
9e8280e19338 Uploaded
iuc
parents:
diff changeset
69 <has_text text="Controls=2,0,4;" />
9e8280e19338 Uploaded
iuc
parents:
diff changeset
70 </assert_contents>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
71 </output>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
72 </test>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
73
9e8280e19338 Uploaded
iuc
parents:
diff changeset
74 <test>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
75 <param name="input" ftype="vcf" value="test.private.02.vcf"/>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
76 <param name="name" value=""/>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
77 <param name="ctrl_src" value="caseString"/>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
78 <param name="caseControlStr" value="-+"/>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
79 <output name="output">
9e8280e19338 Uploaded
iuc
parents:
diff changeset
80 <assert_contents>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
81 <has_text text="Cases=1,0,2;" />
9e8280e19338 Uploaded
iuc
parents:
diff changeset
82 <has_text text="Controls=1,0,2;" />
9e8280e19338 Uploaded
iuc
parents:
diff changeset
83 </assert_contents>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
84 </output>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
85 </test>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
86 </tests>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
87 <help>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
88
9e8280e19338 Uploaded
iuc
parents:
diff changeset
89 **SnpSift CaseControl**
9e8280e19338 Uploaded
iuc
parents:
diff changeset
90
9e8280e19338 Uploaded
iuc
parents:
diff changeset
91 Allows you to count how many samples are in 'case' group and a 'control' group. You can count 'homozygous', 'heterozygous' or 'any' variants.
9e8280e19338 Uploaded
iuc
parents:
diff changeset
92
9e8280e19338 Uploaded
iuc
parents:
diff changeset
93 Case and control are defined by a string containing plus and minus symbols {'+', '-', '0'} where '+' is case, '-' is control and '0' is neutral.
9e8280e19338 Uploaded
iuc
parents:
diff changeset
94
9e8280e19338 Uploaded
iuc
parents:
diff changeset
95 This command adds two annotations to the VCF file:
9e8280e19338 Uploaded
iuc
parents:
diff changeset
96
9e8280e19338 Uploaded
iuc
parents:
diff changeset
97 - **CaseControl**: Two comma separated numbers numbers representing the number of samples that have the variant in the case and the control group. Example:
9e8280e19338 Uploaded
iuc
parents:
diff changeset
98
9e8280e19338 Uploaded
iuc
parents:
diff changeset
99 "CaseControl=3,4" *the variant is present in 3 cases and 4 controls.*
9e8280e19338 Uploaded
iuc
parents:
diff changeset
100
9e8280e19338 Uploaded
iuc
parents:
diff changeset
101
9e8280e19338 Uploaded
iuc
parents:
diff changeset
102 - **CaseControlP**: A p-value (Fisher exact test) that the number of cases is N or more. Example:
9e8280e19338 Uploaded
iuc
parents:
diff changeset
103
9e8280e19338 Uploaded
iuc
parents:
diff changeset
104 "CaseControl=4,0;CaseControlP=3.030303e-02" *in this case the pValue of having 4 or more cases and zero controls is 0.03*
9e8280e19338 Uploaded
iuc
parents:
diff changeset
105
9e8280e19338 Uploaded
iuc
parents:
diff changeset
106
9e8280e19338 Uploaded
iuc
parents:
diff changeset
107 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:
9e8280e19338 Uploaded
iuc
parents:
diff changeset
108
9e8280e19338 Uploaded
iuc
parents:
diff changeset
109 - Hom/Het case = "hom"
9e8280e19338 Uploaded
iuc
parents:
diff changeset
110
9e8280e19338 Uploaded
iuc
parents:
diff changeset
111 - Hom/Het control = "any"
9e8280e19338 Uploaded
iuc
parents:
diff changeset
112
9e8280e19338 Uploaded
iuc
parents:
diff changeset
113 - Case / Control column designation = ""++++------"
9e8280e19338 Uploaded
iuc
parents:
diff changeset
114
9e8280e19338 Uploaded
iuc
parents:
diff changeset
115
9e8280e19338 Uploaded
iuc
parents:
diff changeset
116 @EXTERNAL_DOCUMENTATION@
9e8280e19338 Uploaded
iuc
parents:
diff changeset
117 http://snpeff.sourceforge.net/SnpSift.html#casecontrol
9e8280e19338 Uploaded
iuc
parents:
diff changeset
118
9e8280e19338 Uploaded
iuc
parents:
diff changeset
119 @CITATION_SECTION@
9e8280e19338 Uploaded
iuc
parents:
diff changeset
120
9e8280e19338 Uploaded
iuc
parents:
diff changeset
121 </help>
9e8280e19338 Uploaded
iuc
parents:
diff changeset
122 </tool>