annotate abims_acp.xml @ 0:79c7fdc90ed6 draft default tip

Uploaded
author lecorguille
date Tue, 30 Jun 2015 06:38:09 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
1 <tool id="abims_ACP" name="PCA" version="1.2">
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
2
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
3 <description>Principal Component Analysis using FactoMineR</description>
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
4
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
5 <command interpreter="Rscript">
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
6 abims_acp.r file "$input" graph TRUE scale.unit "$scale_unit" sep "$sep" dec "$dec"
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
7 </command>
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
8
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
9 <inputs>
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
10 <param name="input" type="data" label="Data Matrix file" format="tabular" help="Matrix of numeric data with headers." />
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
11 <!--<param name="graph" type="select" label="graph" help="if FALSE no graph generated">
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
12 <option value="T" selected="true">TRUE</option>
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
13 <option value="F" >FALSE</option>
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
14 </param>-->
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
15 <param name="scale_unit" type="select" label="scale.unit" help="if FALSE no reduction of variables">
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
16 <option value="T" selected="true">TRUE</option>
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
17 <option value="F" >FALSE</option>
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
18 </param>
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
19
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
20 <param name="sep" type="select" format="text" optional="true">
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
21 <label>Separator of columns</label>
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
22 <option value="tabulation">tabulation</option>
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
23 <option value="semicolon">;</option>
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
24 <option value="comma">,</option>
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
25 </param>
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
26 <param name="dec" type="text" label="Decimal separator" value="." help="" />
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
27
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
28 <!--<param name="nr_col_names" type="integer" label="names" value="2" help="number of the column with names of metabolits" />
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
29 <param name="from" type="integer" label="from" value="15" help="number of the column starting peak values data (to exlude all metadata)" />
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
30 <param name="to" type="integer" label="to" value="30" help="number of the column finishing peak values data (to exlude all metadata)" />
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
31 <param name="gr_number" type="integer" label="gr_number" value="2" help="number of groups (conditions)" />
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
32 <param name="nb_col_gr" type="text" label="nb_col_gr" value="8,8" help="number of column of each group; separate with coma as indicated; first position coresponding to the first group etc." />
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
33 <param name="threshold" type="float" label="threshold" value="0.01" help="max adjusted p.value accepted" />-->
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
34
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
35 </inputs>
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
36
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
37 <outputs>
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
38 <data name="acp_zip" format="zip" from_work_dir="acp.zip" label="${input.name[:-4]}.pca.zip"/>
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
39 </outputs>
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
40
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
41 <stdio>
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
42 <exit_code range="1:" level="fatal" />
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
43 </stdio>
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
44
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
45 <help>
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
46
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
47
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
48 .. class:: infomark
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
49
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
50 **Authors** Gildas Le Corguille ABiMS - UPMC/CNRS - Station Biologique de Roscoff - gildas.lecorguille|at|sb-roscoff.fr
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
51
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
52 ---------------------------------------------------
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
53
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
54 ===
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
55 PCA
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
56 ===
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
57
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
58 -----------
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
59 Description
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
60 -----------
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
61
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
62
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
63 Performs **Principal Component Analysis (PCA)** with supplementary individuals, supplementary quantitative variables and supplementary categorical variables.
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
64 Missing values are replaced by the column mean. This scripts uses the FactoMineR package.
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
65
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
66
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
67 -----------
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
68 Input files
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
69 -----------
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
70
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
71 +---------------------------+------------+
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
72 | Parameter : num + label | Format |
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
73 +===========================+============+
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
74 | 1 : Data Matrix file | Tabular |
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
75 +---------------------------+------------+
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
76
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
77
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
78
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
79 ----------
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
80 Parameters
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
81 ----------
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
82
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
83 **Data Matrix file**
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
84
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
85 Matrix of numeric data with headers (tabular format) issued from diffreport or annotateDiffreport to make post xcms analyse .
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
86
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
87 **scale.unit**
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
88
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
89 If FALSE: no reduction of the variables
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
90
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
91 **Separator of columns:**
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
92
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
93 Type of separator for the columns
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
94
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
95 **Decimal separator:**
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
96
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
97 Type of decimal separator of the numbers in your tabular files.
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
98
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
99
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
100
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
101 ------------
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
102 Output files
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
103 ------------
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
104
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
105
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
106
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
107 **input_name.pca.zip**
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
108
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
109 | A zip file containing fours files (eigenvalue.png, percentage_of_variance.png, Rplots.pdf and Rplots1.pdf).
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
110
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
111
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
112 ---------------------------------------------------
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
113
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
114
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
115
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
116 ---------------
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
117 Working example
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
118 ---------------
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
119
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
120
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
121 Input files
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
122 -----------
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
123
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
124 **>A part of an example of Data Matrix file input :**
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
125
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
126
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
127 +--------+------------------+----------------+
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
128 | Name | AN7 | AN8 |
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
129 +========+==================+================+
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
130 |M102T645| 10880.0637170802 |17207.2222120537|
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
131 +--------+------------------+----------------+
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
132 |M105T604| 41911.160863452 |38105.7953589089|
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
133 +--------+------------------+----------------+
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
134
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
135
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
136
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
137 Parameters
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
138 ----------
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
139
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
140 | scale.unit -> **TRUE*
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
141 | Separator of columns: -> **tabulation**
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
142 | Decimal separator -> **.**
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
143
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
144
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
145
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
146 Output files
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
147 ------------
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
148
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
149
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
150 **eigenvalue.png:**
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
151
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
152 .. image:: pca_abims_eigenvalue.png
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
153
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
154 **percentage_of_variance.png:**
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
155
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
156 .. image:: pca_abims_percentage_of_variance.png
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
157
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
158 **Rplots.pdf:**
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
159
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
160 .. image:: pca_abims_Rplots.png
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
161
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
162 **Rplots1.pdf:**
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
163
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
164 .. image:: pca_abims_Rplots1.png
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
165
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
166
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
167
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
168
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
169 </help>
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
170
79c7fdc90ed6 Uploaded
lecorguille
parents:
diff changeset
171 </tool>