annotate Intchecks/xml_intensity_check.xml @ 3:bdee2c2c484b draft

Uploaded
author melpetera
date Fri, 08 Mar 2019 09:07:12 -0500
parents a7553caa2572
children 49c36c54e0cf
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
1 <tool id="intens_check" name="Intensity Check" version="1.2.1">
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
2 <description>Statistical measures, number of missing values and mean fold change</description>
0
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
3 <requirements>
3
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
4 <requirement type="package" version="1.1_5">r-batch</requirement>
0
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
5 </requirements>
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
6 <command interpreter="Rscript">
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
7
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
8 wrapper_intensity_check.R
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
9
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
10 dataMatrix_in "$dataMatrix_in"
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
11 sampleMetadata_in "$sampleMetadata_in"
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
12 variableMetadata_in "$variableMetadata_in"
3
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
13
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
14 method "${method_cond.method}"
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
15
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
16 chosen_stat "${method_cond.chosen_stat}"
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
17
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
18 #if $method_cond.method == "each_class" :
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
19 class_col "${method_cond.class_col}"
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
20 test_fold "${method_cond.test_fold_cond.test_fold}"
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
21 #if $method_cond.test_fold_cond.test_fold == "Yes" :
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
22 logarithm "${method_cond.test_fold_cond.logarithm}"
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
23 #end if
0
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
24 #end if
1
4973a2104cfd Uploaded
melpetera
parents: 0
diff changeset
25
3
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
26 #if $method_cond.method == "one_class" :
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
27 class_col "${method_cond.class_col}"
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
28 class1 "${method_cond.class1}"
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
29 test_fold "${method_cond.test_fold_cond.test_fold}"
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
30 #if $method_cond.test_fold_cond.test_fold == "Yes" :
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
31 fold_frac "${method_cond.test_fold_cond.fold_frac}"
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
32 logarithm "${method_cond.test_fold_cond.logarithm}"
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
33 #end if
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
34 #end if
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
35
0
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
36 variableMetadata_out "$variableMetadata_out"
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
37 graphs_out "$graphs_out"
3
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
38
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
39
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
40
0
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
41 </command>
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
42
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
43 <inputs>
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
44 <param name="dataMatrix_in" type="data" label="Data Matrix file" help="" format="tabular" />
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
45 <param name="sampleMetadata_in" type="data" label="Sample metadata file" help="" format="tabular" />
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
46 <param name="variableMetadata_in" type="data" label="Variable metadata file" help="" format="tabular" />
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
47
3
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
48 <conditional name="method_cond">
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
49 <param name="method" type="select" label="Computation method" help="Select the first method if you don't want to take into account any class of samples">
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
50 <option value="no_class">Without distinction between samples </option>
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
51 <option value="each_class">For each class of samples </option>
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
52 <option value="one_class">Between one class and all the remaining samples </option>
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
53
0
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
54 </param>
3
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
55
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
56 <when value="no_class">
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
57 <param name="chosen_stat" type="select" display="checkboxes" multiple="True" label="Statistics">
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
58 <option value="mean">Mean</option>
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
59 <option value="sd">Standard deviation</option>
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
60 <option value="median">Median</option>
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
61 <option value="quartile">Quartile</option>
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
62 <option value="decile">Decile</option>
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
63 <option value="NA">Missing values</option>
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
64 <validator type="no_options" message="Please choose at least one statistic representation" />
1
4973a2104cfd Uploaded
melpetera
parents: 0
diff changeset
65 </param>
0
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
66 </when>
3
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
67
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
68 <when value="each_class">
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
69 <param name="class_col" type="data_column" data_ref="sampleMetadata_in" use_header_names="true" label="Class column" help="Class column in Sample metadata" />
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
70 <param name="chosen_stat" type="select" display="checkboxes" multiple="True" label="Statistics">
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
71 <option value="mean">Mean</option>
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
72 <option value="sd">Standard deviation</option>
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
73 <option value="median">Median</option>
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
74 <option value="quartile">Quartile</option>
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
75 <option value="decile">Decile</option>
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
76 <option value="NA">Missing values</option>
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
77 </param>
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
78 <conditional name="test_fold_cond">
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
79 <param name="test_fold" type="select" display="radio" label="Calculate the mean fold change">
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
80 <option value="Yes">Yes</option>
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
81 <option value="No">No</option>
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
82 </param>
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
83 <when value="Yes">
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
84 <param name="logarithm" type="select" label="Logarithm" help="Choose if you want the mean fold change to be converted into a log mean fold change (log2 or log10)">
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
85 <option value="none">none </option>
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
86 <option value="log2">log2 </option>
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
87 <option value="log10">log10 </option>
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
88 </param>
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
89 </when>
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
90 </conditional>
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
91 </when>
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
92
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
93 <when value="one_class">
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
94 <param name="class_col" type="data_column" data_ref="sampleMetadata_in" use_header_names="true" label="Class column" help="Class column in Sample metadata" />
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
95 <param name="class1" type="text" label="Selected class" help="Name of the class to test versus all the remaining samples." />
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
96 <param name="chosen_stat" type="select" display="checkboxes" multiple="True" label="Statistics">
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
97 <option value="mean">Mean</option>
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
98 <option value="sd">Standard deviation</option>
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
99 <option value="median">Median</option>
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
100 <option value="quartile">Quartile</option>
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
101 <option value="decile">Decile</option>
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
102 <option value="NA">Missing values</option>
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
103 </param>
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
104 <conditional name="test_fold_cond">
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
105 <param name="test_fold" type="select" display="radio" label="Calculate the mean fold change">
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
106 <option value="Yes">Yes</option>
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
107 <option value="No">No</option>
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
108 </param>
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
109 <when value="Yes">
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
110 <param name="fold_frac" type="select" label="Where should the class be placed for the mean fold change calculation?" display="radio">
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
111 <option value="Top">Numerator (Top) </option>
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
112 <option value="Bottom">Denominator (Bottom) </option>
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
113 </param>
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
114 <param name="logarithm" type="select" label="Logarithm" help="Choose if you want the mean fold change to be converted into a log mean fold change (log2 or log10)">
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
115 <option value="none">none </option>
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
116 <option value="log2">log2 </option>
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
117 <option value="log10">log10 </option>
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
118 </param>
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
119 </when>
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
120 </conditional>
0
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
121 </when>
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
122 </conditional>
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
123 </inputs>
3
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
124
0
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
125
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
126 <outputs>
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
127 <data name="variableMetadata_out" label="IC_${variableMetadata_in.name}" format="tabular" />
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
128 <data name="graphs_out" label="IC_Graphs" format="pdf" />
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
129 </outputs>
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
130
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
131 <help>
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
132
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
133 .. class:: infomark
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
134
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
135 **Authors**
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
136 | Anthony Fernandes - PFEM ; INRA
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
137
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
138 ---------------------------------------------------
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
139
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
140 ========================
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
141 Intensity Check
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
142 ========================
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
143
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
144 -----------
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
145 Input files
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
146 -----------
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
147
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
148 +----------------------------+------------+
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
149 | Parameter | Format |
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
150 +============================+============+
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
151 | 1 : Data Matrix file | tabular |
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
152 +----------------------------+------------+
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
153 | 2 : Sample metadata file | tabular |
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
154 +----------------------------+------------+
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
155 | 3 : Variable metadata file | tabular |
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
156 +----------------------------+------------+
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
157
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
158 ----------
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
159 Parameters
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
160 ----------
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
161
3
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
162 **Computation method**
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
163 | - **Without distinction between samples:** calculates chosen statistic(s) for each variable.
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
164 | - **For each class of samples:** separates samples between each class (class column to specified). Chosen statistic(s) and/or mean fold change are calculated for each of them.
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
165 | - **Between one class versus all the remaining samples:** If you want to focus only on one class versus all the remaining samples without class distinction.
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
166
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
167 | In the case of two classes: "each class" and "one class" give the same results for statistical measures. We recommend to choose "one class" for mean fold change calculation in order to select the class you want to put as numerator or denominator (see below).
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
168
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
169 **Statistics**
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
170 | Select the statistical measures you want to add in the variable metadata table. If the method is "each class" or "one class", you could choose no statistical measure if you only want to calculate the mean fold change (see below).
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
171
0
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
172 **Class column**
2
a7553caa2572 Uploaded
melpetera
parents: 1
diff changeset
173 | Select the class column in sample metadata table.
0
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
174
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
175 **Selected class**
3
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
176 | If the method is "one class", specify it. Remaining samples will be named "Other".
1
4973a2104cfd Uploaded
melpetera
parents: 0
diff changeset
177
3
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
178 **Calculate the mean fold change**
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
179 | Choose if you want to calculate the mean fold change. If the method is "each class": mean fold change will be calculated for all combinations of classes. If the method is "one class": it will be calculated between the selected class (see above) and the remaining samples.
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
180
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
181 **Where should the class be placed for the mean fold change calculation?**
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
182 | If the method is "one class", choose "top" or "bottom" to put the selected class as numerator or denominator (respectively) for the mean fold change calculation.
1
4973a2104cfd Uploaded
melpetera
parents: 0
diff changeset
183
4973a2104cfd Uploaded
melpetera
parents: 0
diff changeset
184 **Logarithm**
4973a2104cfd Uploaded
melpetera
parents: 0
diff changeset
185 | Choose if you want to transform the mean fold change with a log2 or log10.
3
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
186
0
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
187 ------------
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
188 Output file
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
189 ------------
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
190
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
191 **Variable metadata file**
3
bdee2c2c484b Uploaded
melpetera
parents: 2
diff changeset
192 | Contains the previous columns in variable metadata file and the new ones.
2
a7553caa2572 Uploaded
melpetera
parents: 1
diff changeset
193 | In the column names for fold, the first class specified is the one used like numerator for the ratio.
0
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
194
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
195 **Graphs file**
2
a7553caa2572 Uploaded
melpetera
parents: 1
diff changeset
196 | Contains barplots with the proportion of NA considering classes and boxplots with the fold values.
0
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
197
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
198 </help>
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
199
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
200
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
201 </tool>
c2c2e1be904a Uploaded
melpetera
parents:
diff changeset
202