annotate tools/taxonomy/poisson2test.xml @ 1:cdcb0ce84a1b

Uploaded
author xuebing
date Fri, 09 Mar 2012 19:45:15 -0500
parents 9071e359b9a3
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
1 <tool id="poisson2test" name="Poisson two-sample test" version="1.0.0">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
2 <description></description>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
3 <requirements>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
4 <requirement type="package">taxonomy</requirement>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
5 </requirements>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
6 <command interpreter="python">poisson2test.py $input1 $input2 $input3 $input4 $input5 $output1 2>/dev/null </command>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
7 <inputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
8 <param name="input1" format="tabular" type="data" label="Input File"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
9 <param name="input2" type="integer" size="5" value="2" label="First Column"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
10 <param name="input3" type="integer" size="5" value="3" label="Second Column"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
11 <param name="input4" type="float" size="5" value="1" label="D value"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
12 <param name="input5" type="select" label="correction method">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
13 <option value="0">Bonferroni</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
14 <option value="1">FDR</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
15 </param>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
16 </inputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
17 <outputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
18 <data format="tabular" name="output1" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
19 </outputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
20 <tests>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
21 <test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
22 <param name="input1" value="poisson2test1.tabular" ftype="tabular"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
23 <param name="input2" value="2" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
24 <param name="input3" value="3" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
25 <param name="input4" value="0.44" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
26 <param name="input5" value="0" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
27 <output name="output1" file="poisson2test1_out.tabular" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
28 </test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
29 <test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
30 <param name="input1" value="poisson2test2.tabular" ftype="tabular"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
31 <param name="input2" value="2" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
32 <param name="input3" value="3" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
33 <param name="input4" value="0.44" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
34 <param name="input5" value="0" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
35 <output name="output1" file="poisson2test2_out.tabular" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
36 </test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
37 </tests>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
38 <help>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
39
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
40 **What it does**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
41
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
42 Suppose you have metagenomic samples from two different locations and have classified the reads unique to various taxa. Now you want to test if the number of reads that fall in a particular taxon in location 1 is different from those that fall in the same taxon in location 2.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
43 This utility performs this analysis. It assumes that the data comes from a Poisson process and calculates two Z scores (Z1 and Z2) based on the work by Shiue and Bain; 1982 (Z1) and Huffman; 1984 (Z2).
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
44
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
45 -----
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
46
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
47 **Z score formula**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
48
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
49 Equation 1:
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
50
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
51 .. image:: ./static/images/poisson2test_eqn1.png
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
52
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
53
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
54 Equation 2:
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
55
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
56 .. image:: ./static/images/poisson2test_eqn2.png
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
57
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
58
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
59 X = number of reads falling in a particular taxon in location 1
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
60
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
61 Y = number of reads falling in the same taxon in location 2
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
62
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
63 d = correction factor that accounts for biases in sample collection, DNA concentration, read numbers etc. between the two locations.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
64
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
65 Not only that, this utility also provides corresponding p-values and corrected p-values (using Bonferroni or False Discovery Rate (FDR)). It takes in an input file (a tab delimited file consisting of three or more columns (taxon/category, read counts in location 1, read counts in location 2)), columns to compare, d value and a correction method 0 (Bonferroni) or 1 (FDR).
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
66
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
67 -----
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
68
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
69 **Example**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
70
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
71 - Input File: phylum, read count in location-1, read count in location-2::
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
72
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
73 Annelida 36 2
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
74 Apicomplexa 17 8
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
75 Arthropoda 1964 928
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
76 Ascomycota 436 49
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
77 Basidiomycota 77 55
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
78
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
79 - Arguments to be supplied by the user::
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
80
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
81 col_i col_j d-value correction-method
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
82
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
83 2 3 0.44 Bonferroni
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
84
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
85 - Output File: phylum, readcount1, readcount2, z1, z2, p1, p2, corrected p1, corrected p2::
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
86
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
87 Annelida 36 2 3.385 4.276 0.000356 0.000010 0.00463 0.00012
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
88 Apicomplexa 17 8 -0.157 -0.156 0.437707 0.438103 1.00000 1.00000
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
89 Arthropoda 1964 928 -1.790 -1.777 0.036755 0.037744 0.47782 0.49067
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
90 Ascomycota 436 49 9.778 11.418 0.000000 0.000000 0.00000 0.00000
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
91 Basidiomycota 77 55 -2.771 -2.659 0.002792 0.003916 0.03629 0.05091
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
92
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
93 -----
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
94
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
95 **Note**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
96
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
97 - Input file should be Tab delimited
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
98 - i &lt; j
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
99 - d cannot be 0
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
100 - k = Bonferroni or FDR
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
101
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
102 -----
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
103
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
104 **References**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
105
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
106 - Shiue, W. and Bain, L. (1982). Experiment Size and Power Comparisons for Two-Sample Poisson Tests. Applied Statistics 31, 130-134.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
107
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
108 - Huffman, M. D. (1984). An Improved Approximate Two-Sample Poisson Test. Applied Statistics 33, 224-226.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
109
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
110 </help>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
111 </tool>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
112
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
113