annotate poisson2test.xml @ 1:5ff18ec88181 draft default tip

planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/taxonomy/poisson2test commit a1517c9d22029095120643bbe2c8fa53754dd2b7
author devteam
date Wed, 11 Nov 2015 12:56:24 -0500
parents 8cd5945559b8
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
1 <tool id="poisson2test" name="Poisson two-sample test" version="1.0.0">
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
2 <description></description>
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
3 <requirements>
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
4 <requirement type="package" version="1.0.0">taxonomy</requirement>
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
5 </requirements>
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
6 <command interpreter="python">poisson2test.py $input1 $input2 $input3 $input4 $input5 $output1 2>/dev/null </command>
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
7 <inputs>
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
8 <param name="input1" format="tabular" type="data" label="Input File"/>
1
5ff18ec88181 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/taxonomy/poisson2test commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 0
diff changeset
9 <param name="input2" type="integer" value="2" label="First Column"/>
5ff18ec88181 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/taxonomy/poisson2test commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 0
diff changeset
10 <param name="input3" type="integer" value="3" label="Second Column"/>
5ff18ec88181 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/taxonomy/poisson2test commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 0
diff changeset
11 <param name="input4" type="float" value="1" label="D value"/>
0
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
12 <param name="input5" type="select" label="correction method">
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
13 <option value="0">Bonferroni</option>
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
14 <option value="1">FDR</option>
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
15 </param>
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
16 </inputs>
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
17 <outputs>
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
18 <data format="tabular" name="output1" />
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
19 </outputs>
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
20 <tests>
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
21 <test>
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
22 <param name="input1" value="poisson2test1.tabular" ftype="tabular"/>
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
23 <param name="input2" value="2" />
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
24 <param name="input3" value="3" />
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
25 <param name="input4" value="0.44" />
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
26 <param name="input5" value="0" />
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
27 <output name="output1" file="poisson2test1_out.tabular" />
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
28 </test>
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
29 <test>
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
30 <param name="input1" value="poisson2test2.tabular" ftype="tabular"/>
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
31 <param name="input2" value="2" />
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
32 <param name="input3" value="3" />
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
33 <param name="input4" value="0.44" />
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
34 <param name="input5" value="0" />
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
35 <output name="output1" file="poisson2test2_out.tabular" />
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
36 </test>
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
37 </tests>
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
38 <help>
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
39
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
40 **What it does**
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
41
8cd5945559b8 Imported from capsule None
devteam
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.
8cd5945559b8 Imported from capsule None
devteam
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).
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
44
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
45 -----
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
46
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
47 **Z score formula**
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
48
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
49 Equation 1:
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
50
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
51 .. image:: ${static_path}/images/poisson2test_eqn1.png
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
52
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
53
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
54 Equation 2:
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
55
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
56 .. image:: ${static_path}/images/poisson2test_eqn2.png
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
57
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
58
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
59 X = number of reads falling in a particular taxon in location 1
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
60
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
61 Y = number of reads falling in the same taxon in location 2
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
62
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
63 d = correction factor that accounts for biases in sample collection, DNA concentration, read numbers etc. between the two locations.
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
64
8cd5945559b8 Imported from capsule None
devteam
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).
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
66
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
67 -----
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
68
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
69 **Example**
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
70
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
71 - Input File: phylum, read count in location-1, read count in location-2::
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
72
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
73 Annelida 36 2
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
74 Apicomplexa 17 8
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
75 Arthropoda 1964 928
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
76 Ascomycota 436 49
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
77 Basidiomycota 77 55
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
78
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
79 - Arguments to be supplied by the user::
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
80
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
81 col_i col_j d-value correction-method
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
82
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
83 2 3 0.44 Bonferroni
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
84
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
85 - Output File: phylum, readcount1, readcount2, z1, z2, p1, p2, corrected p1, corrected p2::
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
86
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
87 Annelida 36 2 3.385 4.276 0.000356 0.000010 0.00463 0.00012
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
88 Apicomplexa 17 8 -0.157 -0.156 0.437707 0.438103 1.00000 1.00000
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
89 Arthropoda 1964 928 -1.790 -1.777 0.036755 0.037744 0.47782 0.49067
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
90 Ascomycota 436 49 9.778 11.418 0.000000 0.000000 0.00000 0.00000
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
91 Basidiomycota 77 55 -2.771 -2.659 0.002792 0.003916 0.03629 0.05091
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
92
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
93 -----
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
94
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
95 **Note**
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
96
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
97 - Input file should be Tab delimited
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
98 - i &lt; j
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
99 - d cannot be 0
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
100 - k = Bonferroni or FDR
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
101
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
102 -----
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
103
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
104 **References**
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
105
8cd5945559b8 Imported from capsule None
devteam
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.
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
107
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
108 - Huffman, M. D. (1984). An Improved Approximate Two-Sample Poisson Test. Applied Statistics 33, 224-226.
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
109
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
110 </help>
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
111 </tool>
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
112
8cd5945559b8 Imported from capsule None
devteam
parents:
diff changeset
113