annotate README.md @ 3:e91de3b04320 draft

planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit bb92582ec396fd845b49454c4cadd86fbfc73fab
author ethevenot
date Sat, 22 Oct 2016 03:02:47 -0400
parents fa173e12e185
children
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 Multivariate analysis by PCA, PLS(-DA), and OPLS(-DA)
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
2 =====================================================
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
3
2
fa173e12e185 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 9f4dfcdc64aa9ac2a2f6d613cc33961c02fec254-dirty
ethevenot
parents: 1
diff changeset
4 A Galaxy module from the [Workflow4metabolomics](http://workflow4metabolomics.org) infrastructure
0
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
5
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
6 Status: [![Build Status](https://travis-ci.org/workflow4metabolomics/multivariate.svg?branch=master)](https://travis-ci.org/workflow4metabolomics/multivariate).
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
7
2
fa173e12e185 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 9f4dfcdc64aa9ac2a2f6d613cc33961c02fec254-dirty
ethevenot
parents: 1
diff changeset
8 ### Description
0
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
9
3
e91de3b04320 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit bb92582ec396fd845b49454c4cadd86fbfc73fab
ethevenot
parents: 2
diff changeset
10 **Version:** 2.3.8
e91de3b04320 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit bb92582ec396fd845b49454c4cadd86fbfc73fab
ethevenot
parents: 2
diff changeset
11 **Date:** 2016-10-21
0
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
12 **Author:** Etienne A. Thevenot (CEA, LIST, MetaboHUB, W4M Core Development Team)
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
13 **Email:** [etienne.thevenot(at)cea.fr](mailto:etienne.thevenot@cea.fr)
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
14 **Citation:** 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. [doi:10.1021/acs.jproteome.5b00354](http://dx.doi.org/10.1021/acs.jproteome.5b00354)
3
e91de3b04320 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit bb92582ec396fd845b49454c4cadd86fbfc73fab
ethevenot
parents: 2
diff changeset
15 **Licence:** CeCILL
1
da272496b32d planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit dbdc8c3e17ea6ef7139e77cbb6130de949ea2a05
ethevenot
parents: 0
diff changeset
16 **Reference history:** [W4M00001a_sacurine-subset-statistics](http://galaxy.workflow4metabolomics.org/history/list_published), [W4M00001b_sacurine_complete](http://galaxy.workflow4metabolomics.org/history/list_published)
0
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
17 **Funding:** Agence Nationale de la Recherche ([MetaboHUB](http://www.metabohub.fr/index.php?lang=en&Itemid=473) national infrastructure for metabolomics and fluxomics, ANR-11-INBS-0010 grant)
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
18
2
fa173e12e185 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 9f4dfcdc64aa9ac2a2f6d613cc33961c02fec254-dirty
ethevenot
parents: 1
diff changeset
19 ### Installation
0
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
20
2
fa173e12e185 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 9f4dfcdc64aa9ac2a2f6d613cc33961c02fec254-dirty
ethevenot
parents: 1
diff changeset
21 * Configuration file: `multivariate_config.xml`
0
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
22 * Image files:
2
fa173e12e185 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 9f4dfcdc64aa9ac2a2f6d613cc33961c02fec254-dirty
ethevenot
parents: 1
diff changeset
23 + `static/images/multivariate_workflowPositionImage.png`
fa173e12e185 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 9f4dfcdc64aa9ac2a2f6d613cc33961c02fec254-dirty
ethevenot
parents: 1
diff changeset
24 + `static/images/multivariate_workingExampleImage.png`
fa173e12e185 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 9f4dfcdc64aa9ac2a2f6d613cc33961c02fec254-dirty
ethevenot
parents: 1
diff changeset
25 * Wrapper file: `multivariate_wrapper.R`
0
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
26 * R packages
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
27 + **batch** from CRAN
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
28
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
29 ```r
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
30 install.packages("batch", dep=TRUE)
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
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
33 + **ropls** from Bioconductor
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
34
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
35 ```r
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
36 source("http://www.bioconductor.org/biocLite.R")
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
37 biocLite("ropls")
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
38 ```
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
39
2
fa173e12e185 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 9f4dfcdc64aa9ac2a2f6d613cc33961c02fec254-dirty
ethevenot
parents: 1
diff changeset
40 ### Tests
0
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
41
2
fa173e12e185 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 9f4dfcdc64aa9ac2a2f6d613cc33961c02fec254-dirty
ethevenot
parents: 1
diff changeset
42 The code in the wrapper can be tested by running the `runit/multivariate_runtests.R` R file
0
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
43
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
44 You will need to install **RUnit** package in order to make it run:
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
45 ```r
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
46 install.packages('RUnit', dependencies = TRUE)
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
47 ```
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
48
2
fa173e12e185 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 9f4dfcdc64aa9ac2a2f6d613cc33961c02fec254-dirty
ethevenot
parents: 1
diff changeset
49 ### Working example
fa173e12e185 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 9f4dfcdc64aa9ac2a2f6d613cc33961c02fec254-dirty
ethevenot
parents: 1
diff changeset
50
fa173e12e185 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 9f4dfcdc64aa9ac2a2f6d613cc33961c02fec254-dirty
ethevenot
parents: 1
diff changeset
51 See the **W4M00001a_sacurine-subset-statistics**, **W4M00001b_sacurine-subset-complete**, **W4M00002_mtbls2**, **W4M00003_diaplasma** shared histories in the **Shared Data/Published Histories** menu (https://galaxy.workflow4metabolomics.org/history/list_published)
fa173e12e185 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 9f4dfcdc64aa9ac2a2f6d613cc33961c02fec254-dirty
ethevenot
parents: 1
diff changeset
52
fa173e12e185 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 9f4dfcdc64aa9ac2a2f6d613cc33961c02fec254-dirty
ethevenot
parents: 1
diff changeset
53 ### News
0
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
54
3
e91de3b04320 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit bb92582ec396fd845b49454c4cadd86fbfc73fab
ethevenot
parents: 2
diff changeset
55 ###### CHANGES IN VERSION 2.3.8
e91de3b04320 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit bb92582ec396fd845b49454c4cadd86fbfc73fab
ethevenot
parents: 2
diff changeset
56
e91de3b04320 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit bb92582ec396fd845b49454c4cadd86fbfc73fab
ethevenot
parents: 2
diff changeset
57 MINOR MODIFICATION
e91de3b04320 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit bb92582ec396fd845b49454c4cadd86fbfc73fab
ethevenot
parents: 2
diff changeset
58
e91de3b04320 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit bb92582ec396fd845b49454c4cadd86fbfc73fab
ethevenot
parents: 2
diff changeset
59 * (O)PLS(-DA) coefficients display in case of multiple quantitative (or multiclass) response: now the column names of the coefficients for each response are correctly labelled in the variableMetadata file
e91de3b04320 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit bb92582ec396fd845b49454c4cadd86fbfc73fab
ethevenot
parents: 2
diff changeset
60
2
fa173e12e185 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 9f4dfcdc64aa9ac2a2f6d613cc33961c02fec254-dirty
ethevenot
parents: 1
diff changeset
61 ###### CHANGES IN VERSION 2.3.6
fa173e12e185 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 9f4dfcdc64aa9ac2a2f6d613cc33961c02fec254-dirty
ethevenot
parents: 1
diff changeset
62
fa173e12e185 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 9f4dfcdc64aa9ac2a2f6d613cc33961c02fec254-dirty
ethevenot
parents: 1
diff changeset
63 INTERNAL MODIFICATION
fa173e12e185 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 9f4dfcdc64aa9ac2a2f6d613cc33961c02fec254-dirty
ethevenot
parents: 1
diff changeset
64
fa173e12e185 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 9f4dfcdc64aa9ac2a2f6d613cc33961c02fec254-dirty
ethevenot
parents: 1
diff changeset
65 * minor internal modifications
fa173e12e185 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 9f4dfcdc64aa9ac2a2f6d613cc33961c02fec254-dirty
ethevenot
parents: 1
diff changeset
66
fa173e12e185 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 9f4dfcdc64aa9ac2a2f6d613cc33961c02fec254-dirty
ethevenot
parents: 1
diff changeset
67 ###### CHANGES IN VERSION 2.3.4
1
da272496b32d planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit dbdc8c3e17ea6ef7139e77cbb6130de949ea2a05
ethevenot
parents: 0
diff changeset
68
da272496b32d planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit dbdc8c3e17ea6ef7139e77cbb6130de949ea2a05
ethevenot
parents: 0
diff changeset
69 INTERNAL MODIFICATION
da272496b32d planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit dbdc8c3e17ea6ef7139e77cbb6130de949ea2a05
ethevenot
parents: 0
diff changeset
70
da272496b32d planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit dbdc8c3e17ea6ef7139e77cbb6130de949ea2a05
ethevenot
parents: 0
diff changeset
71 * minor update of .shed.yml
da272496b32d planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit dbdc8c3e17ea6ef7139e77cbb6130de949ea2a05
ethevenot
parents: 0
diff changeset
72
2
fa173e12e185 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 9f4dfcdc64aa9ac2a2f6d613cc33961c02fec254-dirty
ethevenot
parents: 1
diff changeset
73 ###### CHANGES IN VERSION 2.3.2
0
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
74
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
75 INTERNAL MODIFICATION
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
76
2
fa173e12e185 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 9f4dfcdc64aa9ac2a2f6d613cc33961c02fec254-dirty
ethevenot
parents: 1
diff changeset
77 * Modification of the `multivariate_wrapper.R` file to handle **ropls** package versions of 1.3.15 and above (i.e. after switching to S4 classes)
0
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
78
2
fa173e12e185 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 9f4dfcdc64aa9ac2a2f6d613cc33961c02fec254-dirty
ethevenot
parents: 1
diff changeset
79 ###### CHANGES IN VERSION 2.3.0
0
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
80
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
81 NEW FEATURES
fafba524dca6 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff changeset
82
2
fa173e12e185 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 9f4dfcdc64aa9ac2a2f6d613cc33961c02fec254-dirty
ethevenot
parents: 1
diff changeset
83 * **Predictions** now available (see the 'Samples to be tested' argument)
fa173e12e185 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 9f4dfcdc64aa9ac2a2f6d613cc33961c02fec254-dirty
ethevenot
parents: 1
diff changeset
84 * OPLS(-DA): **Predictive and Orthogonal VIP** are now computed (see the 'comments' section)
fa173e12e185 planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 9f4dfcdc64aa9ac2a2f6d613cc33961c02fec254-dirty
ethevenot
parents: 1
diff changeset
85 * **Multiclass PLS-DA** implemented (see the 'comments' section)