Mercurial > repos > ethevenot > multivariate
annotate README.md @ 1:da272496b32d draft
planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit dbdc8c3e17ea6ef7139e77cbb6130de949ea2a05
author | ethevenot |
---|---|
date | Sat, 30 Jul 2016 12:31:20 -0400 |
parents | fafba524dca6 |
children | fa173e12e185 |
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 |
fafba524dca6
planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff
changeset
|
4 A Galaxy module from the [Workflow4metabolomics](http://workflow4metabolomics.org) project |
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 |
fafba524dca6
planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff
changeset
|
8 ## Description |
fafba524dca6
planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff
changeset
|
9 |
1
da272496b32d
planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit dbdc8c3e17ea6ef7139e77cbb6130de949ea2a05
ethevenot
parents:
0
diff
changeset
|
10 **Version:** 2.3.4 |
da272496b32d
planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit dbdc8c3e17ea6ef7139e77cbb6130de949ea2a05
ethevenot
parents:
0
diff
changeset
|
11 **Date:** 2016-07-30 |
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) |
1
da272496b32d
planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit dbdc8c3e17ea6ef7139e77cbb6130de949ea2a05
ethevenot
parents:
0
diff
changeset
|
15 **Licence:** CeCILL |
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 |
fafba524dca6
planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff
changeset
|
19 ## Installation |
fafba524dca6
planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff
changeset
|
20 |
fafba524dca6
planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff
changeset
|
21 * Configuration file: `multivariate_config.xml`. |
fafba524dca6
planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff
changeset
|
22 * Image files: |
fafba524dca6
planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff
changeset
|
23 + `static/images/multivariate_workflowPositionImage.png`. |
fafba524dca6
planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff
changeset
|
24 + `static/images/multivariate_workingExampleImage.png`. |
fafba524dca6
planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff
changeset
|
25 * Wrapper file: `multivariate_wrapper.R`. |
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 |
fafba524dca6
planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff
changeset
|
40 ## Tests |
fafba524dca6
planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff
changeset
|
41 |
fafba524dca6
planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff
changeset
|
42 The code in the wrapper can be tested by running the `tests/multivariate_tests.R` in R. |
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 |
fafba524dca6
planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff
changeset
|
49 ## News |
fafba524dca6
planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff
changeset
|
50 |
1
da272496b32d
planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit dbdc8c3e17ea6ef7139e77cbb6130de949ea2a05
ethevenot
parents:
0
diff
changeset
|
51 ### CHANGES IN VERSION 2.3.4 |
da272496b32d
planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit dbdc8c3e17ea6ef7139e77cbb6130de949ea2a05
ethevenot
parents:
0
diff
changeset
|
52 |
da272496b32d
planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit dbdc8c3e17ea6ef7139e77cbb6130de949ea2a05
ethevenot
parents:
0
diff
changeset
|
53 INTERNAL MODIFICATION |
da272496b32d
planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit dbdc8c3e17ea6ef7139e77cbb6130de949ea2a05
ethevenot
parents:
0
diff
changeset
|
54 |
da272496b32d
planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit dbdc8c3e17ea6ef7139e77cbb6130de949ea2a05
ethevenot
parents:
0
diff
changeset
|
55 * minor update of .shed.yml |
da272496b32d
planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit dbdc8c3e17ea6ef7139e77cbb6130de949ea2a05
ethevenot
parents:
0
diff
changeset
|
56 |
da272496b32d
planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit dbdc8c3e17ea6ef7139e77cbb6130de949ea2a05
ethevenot
parents:
0
diff
changeset
|
57 *** |
da272496b32d
planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit dbdc8c3e17ea6ef7139e77cbb6130de949ea2a05
ethevenot
parents:
0
diff
changeset
|
58 |
0
fafba524dca6
planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff
changeset
|
59 ### CHANGES IN VERSION 2.3.2 |
fafba524dca6
planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff
changeset
|
60 |
fafba524dca6
planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff
changeset
|
61 INTERNAL MODIFICATION |
fafba524dca6
planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff
changeset
|
62 |
fafba524dca6
planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff
changeset
|
63 * 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). |
fafba524dca6
planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff
changeset
|
64 |
fafba524dca6
planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff
changeset
|
65 *** |
fafba524dca6
planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff
changeset
|
66 |
fafba524dca6
planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff
changeset
|
67 ### CHANGES IN VERSION 2.3.0 |
fafba524dca6
planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff
changeset
|
68 |
fafba524dca6
planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff
changeset
|
69 NEW FEATURES |
fafba524dca6
planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff
changeset
|
70 |
fafba524dca6
planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff
changeset
|
71 * **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
|
72 * 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
|
73 * **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
|
74 |
fafba524dca6
planemo upload for repository https://github.com/workflow4metabolomics/multivariate.git commit 6596dbd39d20ee1962d9ebdd87eec04821239760
ethevenot
parents:
diff
changeset
|
75 *** |