annotate README.md @ 1:fdefbc780d2e draft

planemo upload for repository https://github.com/workflow4metabolomics/univariate.git commit 59a3d6b0634a8bbe682d7b755bbb3735c07548dc
author ethevenot
date Sat, 30 Jul 2016 12:38:02 -0400
parents ef64d3752050
children 09799fc16bc6
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
ef64d3752050 planemo upload for repository https://github.com/workflow4metabolomics/univariate.git commit ca0e312e1c986c45310f37effe031f60009fbcab
ethevenot
parents:
diff changeset
1 # Univariate parametric and non-parametric hypothesis testing with correction for multiple testing
ef64d3752050 planemo upload for repository https://github.com/workflow4metabolomics/univariate.git commit ca0e312e1c986c45310f37effe031f60009fbcab
ethevenot
parents:
diff changeset
2
ef64d3752050 planemo upload for repository https://github.com/workflow4metabolomics/univariate.git commit ca0e312e1c986c45310f37effe031f60009fbcab
ethevenot
parents:
diff changeset
3 A Galaxy module from the [Workflow4metabolomics](http://workflow4metabolomics.org) project.
ef64d3752050 planemo upload for repository https://github.com/workflow4metabolomics/univariate.git commit ca0e312e1c986c45310f37effe031f60009fbcab
ethevenot
parents:
diff changeset
4
ef64d3752050 planemo upload for repository https://github.com/workflow4metabolomics/univariate.git commit ca0e312e1c986c45310f37effe031f60009fbcab
ethevenot
parents:
diff changeset
5 Status: [![Build Status](https://travis-ci.org/workflow4metabolomics/univariate.svg?branch=master)](https://travis-ci.org/workflow4metabolomics/univariate).
ef64d3752050 planemo upload for repository https://github.com/workflow4metabolomics/univariate.git commit ca0e312e1c986c45310f37effe031f60009fbcab
ethevenot
parents:
diff changeset
6
ef64d3752050 planemo upload for repository https://github.com/workflow4metabolomics/univariate.git commit ca0e312e1c986c45310f37effe031f60009fbcab
ethevenot
parents:
diff changeset
7 ## Description
ef64d3752050 planemo upload for repository https://github.com/workflow4metabolomics/univariate.git commit ca0e312e1c986c45310f37effe031f60009fbcab
ethevenot
parents:
diff changeset
8
1
fdefbc780d2e planemo upload for repository https://github.com/workflow4metabolomics/univariate.git commit 59a3d6b0634a8bbe682d7b755bbb3735c07548dc
ethevenot
parents: 0
diff changeset
9 **Version:** 2.1.2
fdefbc780d2e planemo upload for repository https://github.com/workflow4metabolomics/univariate.git commit 59a3d6b0634a8bbe682d7b755bbb3735c07548dc
ethevenot
parents: 0
diff changeset
10 **Date:** 2016-07-30
0
ef64d3752050 planemo upload for repository https://github.com/workflow4metabolomics/univariate.git commit ca0e312e1c986c45310f37effe031f60009fbcab
ethevenot
parents:
diff changeset
11 **Author:** Marie Tremblay-Franco (INRA, MetaToul, MetaboHUB, W4M Core Development Team) and Etienne A. Thevenot (CEA, LIST, MetaboHUB, W4M Core Development Team)
ef64d3752050 planemo upload for repository https://github.com/workflow4metabolomics/univariate.git commit ca0e312e1c986c45310f37effe031f60009fbcab
ethevenot
parents:
diff changeset
12 **Email:** [marie.tremblay-franco(at)toulouse.inra.fr](mailto:marie.tremblay-franco@toulouse.inra.fr); [etienne.thevenot(at)cea.fr](mailto:etienne.thevenot@cea.fr)
ef64d3752050 planemo upload for repository https://github.com/workflow4metabolomics/univariate.git commit ca0e312e1c986c45310f37effe031f60009fbcab
ethevenot
parents:
diff changeset
13 **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)
ef64d3752050 planemo upload for repository https://github.com/workflow4metabolomics/univariate.git commit ca0e312e1c986c45310f37effe031f60009fbcab
ethevenot
parents:
diff changeset
14 **Reference history:** [W4M00001a_sacurine-subset-statistics](http://galaxy.workflow4metabolomics.org/history/list_published), [W4M00004_mtbls1](http://galaxy.workflow4metabolomics.org/history/list_published)
ef64d3752050 planemo upload for repository https://github.com/workflow4metabolomics/univariate.git commit ca0e312e1c986c45310f37effe031f60009fbcab
ethevenot
parents:
diff changeset
15 **Licence:** CeCILL
ef64d3752050 planemo upload for repository https://github.com/workflow4metabolomics/univariate.git commit ca0e312e1c986c45310f37effe031f60009fbcab
ethevenot
parents:
diff changeset
16 **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)
ef64d3752050 planemo upload for repository https://github.com/workflow4metabolomics/univariate.git commit ca0e312e1c986c45310f37effe031f60009fbcab
ethevenot
parents:
diff changeset
17
ef64d3752050 planemo upload for repository https://github.com/workflow4metabolomics/univariate.git commit ca0e312e1c986c45310f37effe031f60009fbcab
ethevenot
parents:
diff changeset
18 ## Installation
ef64d3752050 planemo upload for repository https://github.com/workflow4metabolomics/univariate.git commit ca0e312e1c986c45310f37effe031f60009fbcab
ethevenot
parents:
diff changeset
19
ef64d3752050 planemo upload for repository https://github.com/workflow4metabolomics/univariate.git commit ca0e312e1c986c45310f37effe031f60009fbcab
ethevenot
parents:
diff changeset
20 * Configuration file: **univariate_config.xml**
ef64d3752050 planemo upload for repository https://github.com/workflow4metabolomics/univariate.git commit ca0e312e1c986c45310f37effe031f60009fbcab
ethevenot
parents:
diff changeset
21 * Image file:
ef64d3752050 planemo upload for repository https://github.com/workflow4metabolomics/univariate.git commit ca0e312e1c986c45310f37effe031f60009fbcab
ethevenot
parents:
diff changeset
22 + **static/images/univariate_workflowPositionImage.png**
ef64d3752050 planemo upload for repository https://github.com/workflow4metabolomics/univariate.git commit ca0e312e1c986c45310f37effe031f60009fbcab
ethevenot
parents:
diff changeset
23 * Wrapper file: **univariate_wrapper.R**
ef64d3752050 planemo upload for repository https://github.com/workflow4metabolomics/univariate.git commit ca0e312e1c986c45310f37effe031f60009fbcab
ethevenot
parents:
diff changeset
24 * Script file: **univariate_script.R**
ef64d3752050 planemo upload for repository https://github.com/workflow4metabolomics/univariate.git commit ca0e312e1c986c45310f37effe031f60009fbcab
ethevenot
parents:
diff changeset
25 * R packages
ef64d3752050 planemo upload for repository https://github.com/workflow4metabolomics/univariate.git commit ca0e312e1c986c45310f37effe031f60009fbcab
ethevenot
parents:
diff changeset
26 + **batch** from CRAN: `install.packages("batch", dep=TRUE)`.
ef64d3752050 planemo upload for repository https://github.com/workflow4metabolomics/univariate.git commit ca0e312e1c986c45310f37effe031f60009fbcab
ethevenot
parents:
diff changeset
27 + **PMCMR** from Bioconductor: `install.packages("PMCMR", dep=TRUE)`.
ef64d3752050 planemo upload for repository https://github.com/workflow4metabolomics/univariate.git commit ca0e312e1c986c45310f37effe031f60009fbcab
ethevenot
parents:
diff changeset
28
ef64d3752050 planemo upload for repository https://github.com/workflow4metabolomics/univariate.git commit ca0e312e1c986c45310f37effe031f60009fbcab
ethevenot
parents:
diff changeset
29 ## Tests
ef64d3752050 planemo upload for repository https://github.com/workflow4metabolomics/univariate.git commit ca0e312e1c986c45310f37effe031f60009fbcab
ethevenot
parents:
diff changeset
30
ef64d3752050 planemo upload for repository https://github.com/workflow4metabolomics/univariate.git commit ca0e312e1c986c45310f37effe031f60009fbcab
ethevenot
parents:
diff changeset
31 The code in the wrapper can be tested by running the **tests/univariate_tests.R** in R
ef64d3752050 planemo upload for repository https://github.com/workflow4metabolomics/univariate.git commit ca0e312e1c986c45310f37effe031f60009fbcab
ethevenot
parents:
diff changeset
32
ef64d3752050 planemo upload for repository https://github.com/workflow4metabolomics/univariate.git commit ca0e312e1c986c45310f37effe031f60009fbcab
ethevenot
parents:
diff changeset
33 ## News
ef64d3752050 planemo upload for repository https://github.com/workflow4metabolomics/univariate.git commit ca0e312e1c986c45310f37effe031f60009fbcab
ethevenot
parents:
diff changeset
34
1
fdefbc780d2e planemo upload for repository https://github.com/workflow4metabolomics/univariate.git commit 59a3d6b0634a8bbe682d7b755bbb3735c07548dc
ethevenot
parents: 0
diff changeset
35 ## CHANGES IN VERSION 2.1.2
fdefbc780d2e planemo upload for repository https://github.com/workflow4metabolomics/univariate.git commit 59a3d6b0634a8bbe682d7b755bbb3735c07548dc
ethevenot
parents: 0
diff changeset
36
fdefbc780d2e planemo upload for repository https://github.com/workflow4metabolomics/univariate.git commit 59a3d6b0634a8bbe682d7b755bbb3735c07548dc
ethevenot
parents: 0
diff changeset
37 * Minor internal changes in .shed.yml for toolshed export
fdefbc780d2e planemo upload for repository https://github.com/workflow4metabolomics/univariate.git commit 59a3d6b0634a8bbe682d7b755bbb3735c07548dc
ethevenot
parents: 0
diff changeset
38
0
ef64d3752050 planemo upload for repository https://github.com/workflow4metabolomics/univariate.git commit ca0e312e1c986c45310f37effe031f60009fbcab
ethevenot
parents:
diff changeset
39 ## CHANGES IN VERSION 2.1.1
ef64d3752050 planemo upload for repository https://github.com/workflow4metabolomics/univariate.git commit ca0e312e1c986c45310f37effe031f60009fbcab
ethevenot
parents:
diff changeset
40
ef64d3752050 planemo upload for repository https://github.com/workflow4metabolomics/univariate.git commit ca0e312e1c986c45310f37effe031f60009fbcab
ethevenot
parents:
diff changeset
41 * Internal handling of 'NA' p-values (e.g. when intensities are identical in all samples).