annotate compute_q_values.xml @ 0:b617b4b3d913 draft

Uploaded
author devteam
date Tue, 20 Aug 2013 09:34:16 -0400
parents
children f74ef191a772
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
1 <tool id="compute_q_values" name="Compute q-values" version="1.0.1">
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
2 <description>based on multiple simultaneous tests p-values</description>
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
3
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
4 <command interpreter="perl">
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
5 compute_q_values.pl $inputFile1 $inputLambda2 $inputPI0_method3 $inputFDR_level4 $inputRobust5 $outputFile1 $outputFile2
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
6 </command>
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
7
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
8 <inputs>
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
9 <param format="tabular" name="inputFile1" type="data" label="Select the p-values file"/>
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
10
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
11 <param type="text" name="inputLambda2" size="100" value="sequence_from_0_to_0.95_increment_0.05" label="What is the lambda value?" help="Either choose the default sequence or one deciaml value between 0 and 1"/>
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
12
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
13 <param name="inputPI0_method3" type="select" label="Choose the PI method:">
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
14 <option value="smoother">smoother</option>
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
15 <option value="bootstrap">bootstrap</option>
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
16 </param>
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
17
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
18 <param type="float" name="inputFDR_level4" size="5" value="" label="What is the FDR level?" help="The FDR level must be between 0 and 1"/>
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
19
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
20 <param name="inputRobust5" type="select" label="Do you want to make the estimate more robust:" help="Choose TRUE for small p-values">
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
21 <option value="FALSE">FALSE</option>
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
22 <option value="TRUE">TRUE</option>
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
23 </param>
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
24 </inputs>
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
25
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
26 <outputs>
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
27 <data format="tabular" name="outputFile1"/>
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
28 <data format="pdf" name="outputFile2"/>
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
29 </outputs>
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
30
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
31 <tests>
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
32 <test>
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
33 <param name="inputFile1" value="p_values.tabular" ftype="tabular" />
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
34 <param name="inputLambda2" value="sequence_from_0_to_0.95_increment_0.05" />
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
35 <param name="inputPI0_method3" value="smoother" />
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
36 <param name="inputFDR_level4" value="0.05" />
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
37 <param name="inputRobust5" value="FALSE" />
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
38 <output name="outputFile1" file="q_values.tabular" />
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
39 <output name="outputFile1" file="p_q_hists_Q_plots.pdf" />
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
40 </test>
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
41 </tests>
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
42
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
43 <help>
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
44
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
45 .. class:: infomark
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
46
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
47 **What it does**
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
48
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
49 This program computes the q-values based on the p-values of multiple simultaneous tests. The q-values are computed using a specific R package, created by John Storey and Alan Dabney, called "qvalue". The program takes five inputs:
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
50
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
51 - The first input is a TABULAR format file consisting of one column only that represents the p-values of multiple simultaneous tests, one line for every p-value.
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
52 - The second input is the lambda parameter. The user can choose either the default: seq(0, 0.95, 0.05) or a decimal number between 0.0 and 1.0.
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
53 - The third input is PI method which is either "smoother" or "bootstrap".
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
54 - The fourth input is the FDR (false discovery rate) level which is a decimal number between 0.0 and 1.0.
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
55 - The fifth input is either TRUE or FALSE for the estimate robustness.
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
56
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
57 The program gives two outputs:
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
58
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
59 - The first output is a TABULAR format file consisting of three columns:
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
60
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
61 - the left column represents the p-values of multiple simultaneous tests, one line for every p-value
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
62 - the middle column represents the q-values corresponding to the p-values
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
63 - the third column represent the significance values, either 1 for significant or 0 for non-significant
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
64
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
65 - The second output is a PDF format file consisting of three pages:
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
66
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
67 - the first page represents the p-values histogram
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
68 - the second page represents the q-values histogram
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
69 - the third page represents the four Q-plots as introduced in the "qvalue" package manual.
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
70
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
71
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
72 **Example**
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
73
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
74 Let us have the first input file of p-values as follows::
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
75
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
76 0.140627492
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
77 0.432249886
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
78 0.122120877
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
79 0.142010182
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
80 0.012909858
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
81 0.000142807
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
82 0.039841941
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
83 0.035173303
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
84 0.011340057
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
85 1.01E-05
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
86 0.212738282
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
87 0.091256284
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
88 0.547375415
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
89 0.189589833
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
90 6.18E-12
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
91 0.001235875
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
92 1.10E-05
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
93 9.75E-07
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
94 2.13E-18
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
95 2.54E-16
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
96 1.20E-19
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
97 9.76E-14
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
98 0.359181534
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
99 0.03661672
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
100 0.400459987
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
101 0.387436466
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
102 0.342075061
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
103 0.904129283
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
104 0.031152635
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
105
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
106 Running the program will give the following output::
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
107
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
108 pi0: 0.140311054
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
109
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
110 FDR level: 0.05
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
111
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
112 p-value q-value significant
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
113 0.1406275 0.02889212 1
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
114 0.4322499 0.06514199 0
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
115 0.1221209 0.02760624 1
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
116 0.1420102 0.02889212 1
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
117 0.01290986 0.00437754 1
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
118 0.000142807 6.46E-05 1
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
119 0.03984194 0.01013235 1
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
120 0.0351733 0.009932946 1
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
121 0.01134006 0.004194811 1
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
122 1.01E-05 5.59E-06 1
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
123 0.2127383 0.03934711 1
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
124 0.09125628 0.02184257 1
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
125 0.5473754 0.07954578 0
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
126 0.1895898 0.03673547 1
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
127 6.18E-12 5.03E-12 1
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
128 0.001235875 0.00050288 1
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
129 1.10E-05 5.59E-06 1
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
130 9.75E-07 6.61E-07 1
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
131 2.13E-18 4.33E-18 1
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
132 2.54E-16 3.45E-16 1
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
133 1.20E-19 4.88E-19 1
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
134 9.76E-14 9.93E-14 1
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
135 0.3591815 0.06089654 0
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
136 0.03661672 0.009932946 1
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
137 0.40046 0.0626723 0
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
138 0.3874365 0.0626723 0
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
139 0.3420751 0.06051785 0
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
140 0.9041293 0.1268593 0
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
141 0.03115264 0.009750824 1
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
142
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
143
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
144 .. image:: ${static_path}/operation_icons/p_hist.png
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
145
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
146
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
147 .. image:: ${static_path}/operation_icons/q_hist.png
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
148
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
149
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
150 .. image:: ${static_path}/operation_icons/Q_plots.png
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
151
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
152
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
153 </help>
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
154
b617b4b3d913 Uploaded
devteam
parents:
diff changeset
155 </tool>