annotate multivariate_config.xml @ 0:fafba524dca6 draft

planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
author ethevenot
date Wed, 27 Jul 2016 11:22:56 -0400
parents
children da272496b32d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
1 <tool id="Multivariate" name="Multivariate" version="2.3.2">
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
2 <description>PCA, PLS and OPLS</description>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
3
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
4 <requirements>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
5 <requirement type="package" version="3.2.2">R</requirement>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
6 <requirement type="package">r-batch</requirement>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
7 <requirement type="package" version="1.4.2">bioconductor-ropls</requirement>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
8 </requirements>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
9
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
10 <command><![CDATA[
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
11 $__tool_directory__/multivariate_wrapper.R
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
12
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
13 dataMatrix_in "$dataMatrix_in"
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
14 sampleMetadata_in "$sampleMetadata_in"
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
15 variableMetadata_in "$variableMetadata_in"
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
16
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
17 respC "$respC"
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
18 predI "$predI"
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
19 orthoI "$orthoI"
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
20 testL "$testL"
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
21
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
22 #if $advGph.opgC == "full"
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
23 typeC "$advGph.typeC"
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
24 parAsColC "$advGph.parAsColC"
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
25 parCexN "$advGph.parCexN"
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
26 parPc1I "$advGph.parPc1I"
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
27 parPc2I "$advGph.parPc2I"
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
28 parMahalC "$advGph.parMahalC"
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
29 parLabVc "$advGph.parLabVc"
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
30 #end if
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
31
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
32 #if $advCpt.opcC == "full"
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
33 algoC "$advCpt.algoC"
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
34 crossvalI "$advCpt.crossvalI"
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
35 log10L "$advCpt.log10L"
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
36 permI "$advCpt.permI"
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
37 scaleC "$advCpt.scaleC"
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
38 #end if
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
39
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
40 sampleMetadata_out "$sampleMetadata_out"
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
41 variableMetadata_out "$variableMetadata_out"
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
42 figure "$figure"
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
43 information "$information"
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
44 ]]></command>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
45
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
46 <inputs>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
47 <param name="dataMatrix_in" label="Data matrix file" type="data" format="tabular" help="variable x sample, decimal: '.', missing: NA, mode: numerical, sep: tabular" />
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
48 <param name="sampleMetadata_in" label="Sample metadata file" type="data" format="tabular" help="sample x metadata, decimal: '.', missing: NA, mode: character and numerical, sep: tabular" />
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
49 <param name="variableMetadata_in" label="Variable metadata file" type="data" format="tabular" help="variable x metadata, decimal: '.', missing: NA, mode: character and numerical, sep: tabular" />
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
50 <param name="respC" label="Y Response (for (O)PLS(-DA) only)" type="text" value = "none" help="Notes: 1) PCA: keep the default (none); 2) (O)PLS(-DA): indicate the name of the column of the sample table to be modeled" />
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
51
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
52 <param name="predI" label="Number of predictive components" type="select" help="Notes: 1) PCA and PLS(-DA): NA can be selected to get a suggestion of the optimal number of predictive components; 2) OPLS(-DA) modeling: select 1 predictive component">
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
53 <option value="NA" selected="true">NA</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
54 <option value="1">1</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
55 <option value="2">2</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
56 <option value="3">3</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
57 <option value="4">4</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
58 <option value="5">5</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
59 <option value="6">6</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
60 <option value="7">7</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
61 <option value="8">8</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
62 <option value="9">9</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
63 <option value="10">10</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
64 </param>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
65 <param name="orthoI" label="Number of orthogonal components (for OPLS(-DA) only)" type="select" help="Notes: 1) PCA and PLS(-DA): keep the default value (0); 2) OPLS(-DA): NA can be selected to get a suggestion of the optimal number of orthogonal components">
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
66 <option value="0">0</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
67 <option value="NA">NA</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
68 <option value="1">1</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
69 <option value="2">2</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
70 <option value="3">3</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
71 <option value="4">4</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
72 <option value="5">5</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
73 <option value="6">6</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
74 <option value="7">7</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
75 <option value="8">8</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
76 <option value="9">9</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
77 <option value="10">10</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
78 </param>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
79
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
80 <param name="testL" label="Samples to be tested" type="select" help="In case predictions should be computed on test samples, provide in your sampleMetadata a column named test. (use exactly this column name, with the dot at the end) and containing yes and no values to indicate which samples should be tested; for those samples, the values of the response will not be used (you can leave NA in the response column of the sample metadata)">
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
81 <option value="TRUE">yes</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
82 <option value="FALSE" selected="true">no</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
83 </param>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
84
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
85 <conditional name="advGph">
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
86 <param name="opgC" type="select" label="Advanced graphical parameters" >
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
87 <option value="default" selected="true">Use default</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
88 <option value="full">Full parameter list</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
89 </param>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
90
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
91 <when value="default"/>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
92 <when value="full">
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
93 <param name="typeC" label="Graphic type" type="select" help="">
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
94 <option value="correlation">correlation</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
95 <option value="outlier">outlier</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
96 <option value="overview">overview</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
97 <option value="permutation">permutation</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
98 <option value="predict-train">predict-train</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
99 <option value="summary" selected="true">summary</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
100 <option value="x-loading">x-loading</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
101 <option value="x-score">x-score</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
102 <option value="x-variance">x-variance</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
103 <option value="xy-score">xy-score</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
104 <option value="xy-weight">xy-weight</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
105 </param>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
106 <param name="parMahalC" label="Ellipses" type="text" value = "NA" help="Name of the sample metadata column with the classes to be used for drawing ellipses; for (O)PLS-DA, the default 'NA' means that the same name as the 'Response' argument above will be used; if you do not want ellipses, use none instead of NA" />
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
107 <param name="parAsColC" label="Sample colors" type="text" value = "none" help="Indicate the name of the sample metadata column with the names to be converted into colors; by default (none), data matrix sample names will be used" />
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
108 <param name="parLabVc" label="Sample labels" type="text" value = "none" help="Indicate the name of the sample metadata column with the names to be used as labels; By default (none), sample names from the data matrix will be used" />
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
109 <param name="parPc1I" label="Component to be displayed as abscissa" type="select" value = "-" help="In case of OPLS(-DA), the first component (i.e. the predictive component) must be set to 1">
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
110 <option value="1">1</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
111 <option value="2">2</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
112 <option value="3">3</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
113 <option value="4">4</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
114 <option value="5">5</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
115 <option value="6">6</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
116 <option value="7">7</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
117 <option value="8">8</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
118 <option value="9">9</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
119 <option value="10">10</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
120 </param>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
121 <param name="parPc2I" label="Component to be displayed as ordinate" type="select" help="In case of OPLS(-DA), the orthogonal component of the selected value - 1 will be displayed (e.g. to see the first orthogonal component, select the value '2' below)">
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
122 <option value="2">2</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
123 <option value="3">3</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
124 <option value="4">4</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
125 <option value="5">5</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
126 <option value="6">6</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
127 <option value="7">7</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
128 <option value="8">8</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
129 <option value="9">9</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
130 <option value="10">10</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
131 </param>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
132 <param name="parCexN" type="float" value="0.8" label="Amount by which plotting text should be magnified relative to the default"/>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
133
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
134 </when>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
135 </conditional>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
136
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
137 <conditional name="advCpt">
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
138 <param name="opcC" type="select" label="Advanced computational parameters" >
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
139 <option value="default" selected="true">Use default</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
140 <option value="full">Full parameter list</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
141 </param>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
142
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
143 <when value="default"/>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
144 <when value="full">
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
145 <param name="scaleC" label="Scaling" type="select" help="Select 'standard' for mean-centering and unit-variance scaling">
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
146 <option value="standard">standard</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
147 <option value="center">center</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
148 <option value="pareto">pareto</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
149 </param>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
150 <param name="permI" label="Permutation testing for (O)PLS(-DA): Number of permutations" type="select" help="Default is 20 for single response models without train/test partition, and 0 otherwise">
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
151 <option value="0">0</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
152 <option value="20" selected="true">20</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
153 <option value="100">100</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
154 <option value="1000">1000</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
155 </param>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
156 <param name="log10L" label="Log10 transformation" type="select" help="">
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
157 <option value="TRUE">yes</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
158 <option value="FALSE" selected="true">no</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
159 </param>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
160 <param name="algoC" label="Algorithm" type="select" help="Default algorithm is 'svd' for PCA and 'nipals' for PLS and OPLS; when performing PCA with 'svd' on an data matrix containing missing values, NAs are set to half the minimum of non-missing values and a warning is generated; an alternative is to use the 'nipals' algorithm (able to handle a moderate amount of missing values)">
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
161 <option value="default">default</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
162 <option value="nipals">nipals</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
163 <option value="svd">svd</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
164 </param>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
165 <param name="crossvalI" label="Number of cross-validation segments" type="select" help="Must be less than or equal to the number of samples">
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
166 <option value="1">1</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
167 <option value="2">2</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
168 <option value="3">3</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
169 <option value="4">4</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
170 <option value="5">5</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
171 <option value="6">6</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
172 <option value="7" selected="true">7</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
173 <option value="8">8</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
174 <option value="9">9</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
175 <option value="10">10</option>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
176 </param>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
177
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
178 </when>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
179 </conditional>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
180
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
181 </inputs>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
182
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
183 <outputs>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
184 <data name="sampleMetadata_out" label="${tool.name}_${sampleMetadata_in.name}" format="tabular" ></data>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
185 <data name="variableMetadata_out" label="${tool.name}_${variableMetadata_in.name}" format="tabular" ></data>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
186 <data name="figure" label="${tool.name}__figure.pdf" format="pdf"/>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
187 <data name="information" label="${tool.name}__information.txt" format="txt"/>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
188 </outputs>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
189
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
190 <tests>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
191 <test>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
192 <param name="dataMatrix_in" value="input-dataMatrix.tsv"/>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
193 <param name="sampleMetadata_in" value="input-sampleMetadata.tsv"/>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
194 <param name="variableMetadata_in" value="input-variableMetadata.tsv"/>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
195 <param name="respC" value="age"/>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
196 <param name="predI" value="1"/>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
197 <param name="orthoI" value="1"/>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
198 <param name="testL" value="FALSE"/>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
199 <output name="sampleMetadata_out">
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
200 <assert_contents>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
201 <has_n_columns n="9"/>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
202 </assert_contents>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
203 </output>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
204 <output name="variableMetadata_out">
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
205 <assert_contents>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
206 <has_n_columns n="7"/>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
207 </assert_contents>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
208 </output>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
209 </test>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
210 </tests>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
211
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
212 <help>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
213
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
214 .. class:: infomark
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
215
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
216 **Author** Etienne Thevenot (CEA, LIST, MetaboHUB Paris, etienne.thevenot@cea.fr)
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
217
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
218 ---------------------------------------------------
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
219
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
220 .. class:: infomark
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
221
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
222 **Please cite**
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
223
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
224 Etienne A. Thevenot, Aurelie Roux, Ying Xu, Eric Ezan, and Christophe Junot (2015). Analysis of the human adult urinary metabolome variations with age, body mass index and gender by implementing a comprehensive workflow for univariate and OPLS statistical analyses. *Journal of Proteome Research*, **14**:3322-3335 (http://dx.doi.org/10.1021/acs.jproteome.5b00354).
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
225
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
226 ---------------------------------------------------
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
227
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
228 .. class:: infomark
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
229
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
230 **R package**
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
231
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
232 The *ropls* package is available from the bioconductor repository (http://bioconductor.org/packages/ropls).
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
233
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
234 ---------------------------------------------------
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
235
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
236 .. class:: infomark
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
237
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
238 **Tool updates**
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
239
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
240 See the **NEWS** section at the bottom of this page
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
241
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
242 ---------------------------------------------------
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
243
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
244 ==============================================
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
245 Multivariate analysis with PCA and (O)PLS(-DA)
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
246 ==============================================
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
247
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
248 -----------
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
249 Description
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
250 -----------
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
251
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
252 **Latent variable modeling** with Principal Component Analysis (**PCA**) and Partial Least Squares (**PLS**) are powerful methods for **visualization**, **regression**, **classification**, and feature selection of **omics data** where the number of variables exceeds the number of samples and with multicollinearity among variables (Wold et al, 2001; Thenenhaus, 1998; Wehrens, 2011; Eriksson et al, 2006; Trygg et al, 2007). Orthogonal Partial Least Squares (**OPLS**) enables to separately model the variation correlated (predictive) to the factor of interest and the uncorrelated (orthogonal) variation (Trygg and Wold, 2002). While performing similarly to PLS, OPLS facilitates interpretation. Successful applications of these chemometrics techniques include spectroscopic data such as Raman spectroscopy, nuclear magnetic resonance (NMR), mass spectrometry (MS) in metabolomics and proteomics, but also transcriptomics data. In addition to **scores**, **loadings** and **weights** plots, the module provides metrics and graphics to determine the optimal number of components (e.g. with the **R2** and **Q2** coefficients; Wold et al, 2001; Thenenhaus, 1998; Eriksson et al, 2006), check the **validity of the model** by permutation testing (Szymanska et al, 2012), detect **outliers** (Wold et al, 2001; Thenenhaus, 1998; Hubert et al, 2005), and provide several metrics to assess the importance of the variables in the model (e.g. **Variable Importance in Projection** or regression coefficients; Wold et al, 2001; Mehmood et al, 2012; Galindo-Prieto et al, 2014). The module is an implementation of the **ropls** R package available from Bioconductor (Thevenot et al, 2015).
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
253
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
254 --------
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
255 Comments
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
256 --------
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
257
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
258 1) Overfitting
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
259 | Overfitting (i.e., building a model with good performances on the training set but poor performances on a new test set) is a major caveat of machine learning techniques applied to data sets with more variables than samples. A simple simulation with a random dataMatrix and a random response shows that perfect PLS-DA classification can be achieved as soon as the number of variables exceeds the number of samples (Wehrens, 2011). It is therefore essential to check that the Q2 value of the model is significant by random permutation of the labels: the number of permutations (advanced computational parameter) is set to 20 by default but should be increased for confirmation of the results.
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
260
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
261 2) VIP from OPLS models
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
262 | The classical VIP metric is not useful for OPLS modeling of a single response since (Galindo-Prieto et al, 2014; Thevenot et al, 2015). In fact, when features are standardized, we can demonstrate a mathematical relationship between VIP and *p*-values from a Pearson correlation test (Thevenot et al, 2015): classical VIP are therefore univariate for OPLS(-DA) models (and identical whatever the number of orthogonal components of the model).
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
263 | Galindo-Prieto et al. (2014) have therefore recently suggested new VIP metrics for OPLS, VIP*pred* and VIP*ortho*, to separately measure the influence of the features in the modeling of the dispersion correlated to, and orthogonal to the response, respectively.
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
264 | For OPLS(-DA) models, the output variableMetadata contains the 2 metrics: VIP_pred is a measure of the variable importance in prediction and VIP_ortho is a measure of the variable importance in orthogonal modeling. VIP_pred and VIP_ortho are scaled as the classical VIP (i.e., the mean of their squared values equals 1).
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
265
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
266 3) (Orthogonal) Partial Least Squares Discriminant Analysis: (O)PLS-DA
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
267 | The approach for discriminant analysis implemented in the module relies on internal conversion of the response into a dummy vector (resp. a matrix when the number of classes is > 2), mean-centering and unit-variance scaling of the vector (resp. the matrix), and PLS (resp. PLS2) regression modeling.
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
268 | When the sizes of the 2 classes are unbalanced, Brereton and Lloyd (2014) have demonstrated that a bias is introduced in the computation of the decision rule, which penalizes the class with the highest size. In the multiclass case, the proportions of 0 and 1 in the columns is usually unbalanced (even in the case of balanced size of the classes) resulting in a bias (Brereton and Llyod, 2014).
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
269 | With the current implementation of the module, we thus recommend to stick to binary discrimination and use balanced classes for optimal use.
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
270
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
271 ----------
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
272 References
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
273 ----------
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
274
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
275 | Brereton R.G. and Lloyd G.R. (2014). Partial least squares discriminant analysis: taking the magic away. *Journal of Chemometrics*, 28:213-225. http://dx.doi.org/10.1002/cem.2609
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
276 | Eriksson I., Johansson E., Kettaneh-Wold N. and Wold S. (2001). Multi- and megavariate data analysis. Principles and applications. *Umetrics Academy*.
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
277 | Galindo-Prieto B., Eriksson L. and Trygg J. (2014). Variable influence on projection (VIP) for orthogonal projections to latent structures (OPLS). *Journal of Chemometrics*, 28:623-632. http://dx.doi.org/10.1002/cem.2627
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
278 | Hubert M., Rousseeuw P. and Vanden Branden K. (2005). ROBPCA: a new approach to robust principal component analysis. *Technometrics*, 47:64-79. http://dx.doi.org/10.1198/004017004000000563
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
279 | Mehmood T., Liland K.H., Snipen L. and Saebo S. (2012). A review of variable selection methods in Partial Least Squares Regression. *Chemometrics and Intelligent Laboratory Systems*, 118:62-69. http://dx.doi.org/10.1016/j.chemolab.2012.07.010
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
280 | Szymanska E., Saccenti E., Smilde A. and Westerhuis J. (2012). Double-check: validation of diagnostic statistics for PLS-DA models in metabolomics studies. *Metabolomics*, 8:3-16. http://dx.doi.org/10.1007/s11306-011-0330-3
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
281 | Tenenhaus M. (1998). La regression PLS : theorie et pratique. *Technip*.
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
282 | Thevenot E.A., Roux A., Xu Y., Ezan E. and Junot C. (2015). Analysis of the human adult urinary metabolome variations with age, body mass index and gender by implementing a comprehensive workflow for univariate and OPLS statistical analyses. *Journal of Proteome Research*, 14:3322-3335. http://dx.doi.org/10.1021/acs.jproteome.5b00354
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
283 | Trygg J. and Wold S. (2002). Orthogonal projection to latent structures (O-PLS). *Journal of Chemometrics*, 16:119-128. http://dx.doi.org/10.1002/cem.695
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
284 | Trygg J., Holmes E. and Lundstedt T. (2007). Chemometrics in Metabonomics. *Journal of Proteome Research*, 6:469-479. http://dx.doi.org/10.1021/pr060594q
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
285 | Wehrens W. (2011). Chemometrics with R. *Springer*.
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
286 | Wold S., Sjostrom M. and Eriksson L. (2001). PLS-regression: a basic tool of chemometrics. *Chemometrics and Intelligent Laboratory Systems*, 58:109-130. http://dx.doi.org/10.1016/S0169-7439(01)00155-1
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
287
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
288 -----------------
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
289 Workflow position
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
290 -----------------
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
291
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
292 .. image:: multivariate_workflowPositionImage.png
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
293 :width: 600
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
294
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
295 -----------
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
296 Input files
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
297 -----------
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
298
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
299 +---------------------------+------------+
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
300 | File | Format |
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
301 +===========================+============+
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
302 | 1) Data matrix | tabular |
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
303 +---------------------------+------------+
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
304 | 2) Sample metadata | tabular |
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
305 +---------------------------+------------+
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
306 | 3) Variable metadata | tabular |
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
307 +---------------------------+------------+
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
308
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
309
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
310 ----------
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
311 Parameters
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
312 ----------
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
313
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
314 Data matrix file
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
315 | variable x sample **dataMatrix** tabular separated file of the numeric data matrix, with . as decimal, and NA for missing values; the table must not contain metadata apart from row and column names; the row and column names must be identical to the rownames of the sample and variable metadata, respectively (see below)
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
316 |
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
317
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
318 Sample metadata file
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
319 | sample x metadata **sampleMetadata** tabular separated file of the numeric and/or character sample metadata, with . as decimal and NA for missing values
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
320 |
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
321
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
322 Variable metadata file
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
323 | variable x metadata **variableMetadata** tabular separated file of the numeric and/or character variable metadata, with . as decimal and NA for missing values
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
324 |
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
325
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
326 Y Response (mandatory for PLS and OPLS; keep the default, none, for PCA)
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
327 | Column of the sample metadata table to be used as (qualitative or quantitative) response for (O)PLS(-DA)
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
328 |
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
329
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
330 Number of (predictive) components (default = NA)
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
331 | For OPLS(-DA), this number is automatically converted to 1; otherwise if set to **NA**, the optimal number of components is automatically determined by cross-validation: components are extracted until (i) PCA case: the variance is less than the mean variance of all components (note that this rule requires all components to be computed and can be quite time-consuming for large datasets) or (ii) PLS case: either R2Y of the component is less than 0.01 or Q2Y is less than 0 (when the dataset contains more than 100 samples) or 0.05 otherwise
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
332 |
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
333
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
334 Number of orthogonal components (mandatory for OPLS(-DA); default = 0 otherwise)
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
335 | When set to **0** [default], PLS will be performed; otherwise OPLS will be peformed; when set to **NA**, OPLS is performed and the number of orthogonal components is automatically computed by using cross-validation
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
336 |
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
337
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
338 Samples for prediction (for (O)PLS(-DA) only; default is no)
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
339 | In case predictions should be computed on test samples, provide in your **sampleMetadata** a column named **test.** (use exactly this column name, with the dot at the end) and containing **yes** and **no** values to indicate which samples should be tested; for those samples, the values of the response will not be used (you can leave **NA** in the response column of the **sampleMetadata**)
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
340 |
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
341
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
342 Advanced graphical parameters
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
343 |
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
344
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
345 Graphic type (default = summary)
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
346 | **summary** 4-plot graphics showing **overview** (or **permutation** when the number of permutations is superior to 0; see below), **outlier**, **x-loading** and **x-score**
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
347 | **correlation** Variable correlations with the components
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
348 | **outlier** Observation diagnostics (score and orthogonal distances)
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
349 | **overview** Model overview showing R2Ycum and Q2cum (or 'Variance explained' for PCA)
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
350 | **permutation** Scatterplot of R2Y and Q2Y actual and simulated models after random permutation of response values
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
351 | **predict-train** Predicted vs Actual Y for the reference set (only if Y has a single column)
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
352 | **x-loading** X-Loadings
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
353 | **x-score** X-Scores
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
354 | **x-varcor** Spread of raw variables corresp. to quantile variances and, if the number of variables is less than 100, correlations between the X-variables
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
355 | **xy-score** XY-Scores,
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
356 | **xy-weight** XY-Weights
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
357 | .pdf image files can be converted to high-resolution .tif images (e.g. for publication) by using in the open-source Gimp software: open the .pdf with resolution = 300, and export as a .tif image without compression
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
358 |
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
359
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
360 Ellipses (default = NA)
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
361 | If 'NA' ellipses are drawn automatically for (O)PLS-DA, or for PCA, when a column of characters is selected in the 'sample colors' argument below. If you do not want ellipses, set to none.
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
362 |
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
363
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
364 Sample colors (default = none)
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
365 | Name of the column of the sample table with the classes to be used for coloring the samples on plots (e.g. for PCA or if you wish to highlight a factor distinct from the response above); by default (none) sample names are converted into a color palette"
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
366 |
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
367
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
368 Sample labels (default = none)
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
369 | Name of the column of the sample table with the classes to be used for labeling the samples on plots; by default (none), sample names will be used
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
370 |
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
371
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
372 Component to be displayed as abscissa (default = 1)
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
373 | In case of OPLS(-DA), the first component (i.e. the predictive component) must be set to 1"
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
374 |
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
375
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
376 Component to be displayed as ordinate (default = 2)
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
377 | Note: In case of OPLS(-DA), the orthogonal component of the value below - 1 will be displayed (e.g. to see the first orthogonal component, select the value **2** (default)
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
378 |
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
379
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
380 Number of variables most contributing to loadings to be highlighted (default = 3)
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
381 | Such variables will be colored in red on the loading plot; In addition, the loading values and the correlation with the components will be printed in the text summary
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
382 |
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
383
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
384 Advanced computational parameters
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
385 |
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
386
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
387 Scaling (default = standard)
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
388 | Either mean-centering alone (**center**), or followed by pareto scaling (**pareto**), or unit-variance scaling (**standard**)
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
389 |
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
390
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
391 Permutation testing for (O)PLS(-DA) models: Number of permutations (default = 20)
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
392 | Number of random permutations of response labels to estimate R2Y and Q2Y significance; Default is 10 for single response models and 0 otherwise
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
393 |
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
394
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
395 Log10 transformation (default = no)
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
396 | Should the data matrix values be log10 transformed? Note: zeros are set to 1 prior to transformation
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
397 |
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
398
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
399 Train/test partition (default = none)
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
400 | When set to **odd**, samples with odd indices are used to train the model, which is subsequently tested on the samples with even indices; a RMSEP (root mean square error estimation of prediction) is computed, in addition to the RMSEE (error of estimation). Note that in case of a qualitative response, the proportion of samples in each class in the full dataset is preserved within the reference and train subsets
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
401 |
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
402
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
403 Algorithm (default = svd for PCA and nipals for PLS and OPLS)
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
404 | When using **svd** (singular value decomposition) for PCA on an **dataMatrix** containing missing values (NA), the latters are set to half the minimum of non-missing values and a warning is generated; an alternative is to use the **nipals** algorithm (non-linear iterative partial least squares, based on a power method to find eigenvalues, and able to handle a small amount of missing values); For PLS and OPLS, only the **nipals** algorithm is available
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
405 |
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
406
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
407 Number of cross-validation segments (default = 7)
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
408 |
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
409
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
410
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
411 ------------
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
412 Output files
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
413 ------------
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
414
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
415
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
416 sampleMetadata_out.tabular
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
417 | **sampleMetadata** file identical to the file given as argument, except that two columns with the x-scores of the displayed components have been added
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
418 |
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
419
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
420 variableMetadata_out.tabular
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
421 | **variableMetadata** file identical to the file given as argument, except that i) 3 columns with the x-loadings of the displayed components, and the regression coefficients, have been added, ii) in the case of PLS, a column with the VIP values (variable importance in projection of the model with all components) has been added, iii) in the case of OPLS, 2 columns with the VIP_pred and VIP_ortho have been added.
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
422 |
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
423
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
424 figure.pdf
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
425 | Graphic
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
426 |
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
427
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
428 information.txt
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
429 | Text file with all messages and warnings generated during the computation
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
430 |
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
431
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
432 ---------------------------------------------------
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
433
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
434 ----------------
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
435 Working examples
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
436 ----------------
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
437
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
438 |
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
439
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
440 .. class:: infomark
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
441
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
442 See the **W4M00001a_sacurine-subset-statistics**, **W4M00001b_sacurine-complete**, **W4M00002_mtbls2** or **W4M00003_diaplasma** shared histories in the **Shared Data/Published Histories** menu
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
443
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
444
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
445 Figure output
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
446 =============
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
447
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
448 .. image:: multivariate_workingExampleImage.png
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
449 :width: 600
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
450
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
451 ---------------------------------------------------
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
452
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
453 ----
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
454 NEWS
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
455 ----
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
456
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
457 CHANGES IN VERSION 2.3.2
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
458 ========================
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
459
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
460 NEW FEATURES
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
461
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
462 Error messages are generated in OPLS(-DA) models in case of non-significance of either the predictive or the first orthogonal component
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
463
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
464 INTERNAL MODIFICATIONS
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
465
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
466 Modifications of the **wrapper** file to handle the recent **ropls** package versions (i.e. 1.3.15 and above) which use S4 classes
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
467
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
468 CHANGES IN VERSION 2.3.0
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
469 ========================
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
470
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
471 NEW FEATURES
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
472
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
473 1) **Predictions** now available (see the 'Samples to be tested' argument)
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
474 2) OPLS(-DA): **Predictive and Orthogonal VIP** are now computed (see the 'comments' section)
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
475 3) **Multiclass PLS-DA** implemented (see the 'comments' section)
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
476
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
477 MINOR MODIFICATIONS
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
478
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
479 1) Changes in color palette: black/grey colors for diagnostics and other colors for scores
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
480 2) Default number of permutations set to 20 (instead of 10)
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
481 3) Predictive components denoted in the tables by 'p' (instead of 'h' previously)
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
482
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
483 CHANGES IN VERSION 2.2.4
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
484 ========================
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
485
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
486 1) Correction in the Galaxy wrapper (in the previous version, the number of predictive components was sometimes set to the maximum by mistake)
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
487 2) The regression coefficients are now provided as a new column of the variableMetadata output
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
488
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
489 CHANGES IN VERSION 2.2.3
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
490 ========================
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
491
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
492 The default number of permutations is set to 10 (instead of 100) as a compromise to enable both a quick computation and a first hint at model significance
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
493
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
494 CHANGES IN VERSION 2.2.2
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
495 ========================
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
496
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
497 1) A default of 100 permutations has been set in order to check for overfitting; in addition, 'permutation', 'overview', and 'outlier' plots are now displayed by default
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
498 2) Classification is currently implemented for two-class responses only
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
499 3) *dataMatrix* is not modified by the tool, so it does not appear as an output files
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
500 4) Double cross-validation (advanced computational parameters): 'odd' now refers to train (instead to test) indices
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
501
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
502 </help>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
503
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
504 <citations/>
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
505 </tool>