Mercurial > repos > ethevenot > checkformat

annotate README.md @ 0:0d8099822c49 draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 217d97da5c733c3628997666c73867e81af0a0ee
author ethevenot
date Sat, 30 Jul 2016 12:06:35 -0400
parents
children e194eec8e70c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
0d8099822c49 planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 217d97da5c733c3628997666c73867e81af0a0ee
ethevenot
parents:
diff changeset
1 ## Checking the formats of the dataMatrix, sampleMetadata, and variableMetadata files
0d8099822c49 planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 217d97da5c733c3628997666c73867e81af0a0ee
ethevenot
parents:
diff changeset
2 #### A Galaxy module from the [Workflow4metabolomics](http://workflow4metabolomics.org) project
0d8099822c49 planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 217d97da5c733c3628997666c73867e81af0a0ee
ethevenot
parents:
diff changeset
3
0d8099822c49 planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 217d97da5c733c3628997666c73867e81af0a0ee
ethevenot
parents:
diff changeset
4 Status: [![Build Status](https://travis-ci.org/workflow4metabolomics/checkformat.svg?branch=master)](https://travis-ci.org/workflow4metabolomics/checkformat).
0d8099822c49 planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 217d97da5c733c3628997666c73867e81af0a0ee
ethevenot
parents:
diff changeset
5
0d8099822c49 planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 217d97da5c733c3628997666c73867e81af0a0ee
ethevenot
parents:
diff changeset
6 ### Description
0d8099822c49 planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 217d97da5c733c3628997666c73867e81af0a0ee
ethevenot
parents:
diff changeset
7
0d8099822c49 planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 217d97da5c733c3628997666c73867e81af0a0ee
ethevenot
parents:
diff changeset
8 **Version:** 2.0.2
0d8099822c49 planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 217d97da5c733c3628997666c73867e81af0a0ee
ethevenot
parents:
diff changeset
9 **Date:** 2016-07-29
0d8099822c49 planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 217d97da5c733c3628997666c73867e81af0a0ee
ethevenot
parents:
diff changeset
10 **Author:** Etienne A. Thevenot (CEA, LIST, MetaboHUB, W4M Core Development Team)
0d8099822c49 planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 217d97da5c733c3628997666c73867e81af0a0ee
ethevenot
parents:
diff changeset
11 **Email:** [etienne.thevenot(at)cea.fr](mailto:etienne.thevenot@cea.fr)
0d8099822c49 planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 217d97da5c733c3628997666c73867e81af0a0ee
ethevenot
parents:
diff changeset
12 **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)
0d8099822c49 planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 217d97da5c733c3628997666c73867e81af0a0ee
ethevenot
parents:
diff changeset
13 **Licence:** CeCILL
0d8099822c49 planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 217d97da5c733c3628997666c73867e81af0a0ee
ethevenot
parents:
diff changeset
14 **Reference histories:**
0d8099822c49 planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 217d97da5c733c3628997666c73867e81af0a0ee
ethevenot
parents:
diff changeset
15 [W4M00001a_sacurine-subset-statistics](http://galaxy.workflow4metabolomics.org/history/list_published), [W4M00001b_sacurine_complete](http://galaxy.workflow4metabolomics.org/history/list_published),
0d8099822c49 planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 217d97da5c733c3628997666c73867e81af0a0ee
ethevenot
parents:
diff changeset
16 [W4M00002_sacurine_mtbls2](http://galaxy.workflow4metabolomics.org/history/list_published), [W4M00003_sacurine_diaplasma](http://galaxy.workflow4metabolomics.org/history/list_published)
0d8099822c49 planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 217d97da5c733c3628997666c73867e81af0a0ee
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)
0d8099822c49 planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 217d97da5c733c3628997666c73867e81af0a0ee
ethevenot
parents:
diff changeset
18
0d8099822c49 planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 217d97da5c733c3628997666c73867e81af0a0ee
ethevenot
parents:
diff changeset
19 ### Installation
0d8099822c49 planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 217d97da5c733c3628997666c73867e81af0a0ee
ethevenot
parents:
diff changeset
20
0d8099822c49 planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 217d97da5c733c3628997666c73867e81af0a0ee
ethevenot
parents:
diff changeset
21 * Configuration file: **checkFormat_config.xml**
0d8099822c49 planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 217d97da5c733c3628997666c73867e81af0a0ee
ethevenot
parents:
diff changeset
22 * Image file: **static/images/checkFormat_workflowPositionImage.png**
0d8099822c49 planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 217d97da5c733c3628997666c73867e81af0a0ee
ethevenot
parents:
diff changeset
23 * Wrapper file: **checkFormat_wrapper.R**
0d8099822c49 planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 217d97da5c733c3628997666c73867e81af0a0ee
ethevenot
parents:
diff changeset
24 * R packages
0d8099822c49 planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 217d97da5c733c3628997666c73867e81af0a0ee
ethevenot
parents:
diff changeset
25 + **batch** from CRAN
0d8099822c49 planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 217d97da5c733c3628997666c73867e81af0a0ee
ethevenot
parents:
diff changeset
26 > install.packages("batch", dep=TRUE)
0d8099822c49 planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 217d97da5c733c3628997666c73867e81af0a0ee
ethevenot
parents:
diff changeset
27
0d8099822c49 planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 217d97da5c733c3628997666c73867e81af0a0ee
ethevenot
parents:
diff changeset
28 ### Tests
0d8099822c49 planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 217d97da5c733c3628997666c73867e81af0a0ee
ethevenot
parents:
diff changeset
29
0d8099822c49 planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 217d97da5c733c3628997666c73867e81af0a0ee
ethevenot
parents:
diff changeset
30 The code in the wrapper can be tested by running the **tests/checkFormat_tests.R** in R
0d8099822c49 planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 217d97da5c733c3628997666c73867e81af0a0ee
ethevenot
parents:
diff changeset
31
0d8099822c49 planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 217d97da5c733c3628997666c73867e81af0a0ee
ethevenot
parents:
diff changeset
32 ### News
0d8099822c49 planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 217d97da5c733c3628997666c73867e81af0a0ee
ethevenot
parents:
diff changeset
33
0d8099822c49 planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 217d97da5c733c3628997666c73867e81af0a0ee
ethevenot
parents:
diff changeset
34 ##### CHANGES IN VERSION 2.0.2
0d8099822c49 planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 217d97da5c733c3628997666c73867e81af0a0ee
ethevenot
parents:
diff changeset
35
0d8099822c49 planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 217d97da5c733c3628997666c73867e81af0a0ee
ethevenot
parents:
diff changeset
36 INTERNAL MODIFICATION
0d8099822c49 planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 217d97da5c733c3628997666c73867e81af0a0ee
ethevenot
parents:
diff changeset
37
0d8099822c49 planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 217d97da5c733c3628997666c73867e81af0a0ee
ethevenot
parents:
diff changeset
38 o Creating tests for R code
0d8099822c49 planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 217d97da5c733c3628997666c73867e81af0a0ee
ethevenot
parents:
diff changeset
39
0d8099822c49 planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 217d97da5c733c3628997666c73867e81af0a0ee
ethevenot
parents:
diff changeset
40 ***