Mercurial > repos > ethevenot > checkformat

annotate README.md @ 1:e194eec8e70c 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 8ebfbfa8d9449c9bbfbf569851a30b1e33df0b3f
author ethevenot
date Sat, 06 Aug 2016 11:54:28 -0400
parents 0d8099822c49
children 80a38d36f946
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
e194eec8e70c planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 8ebfbfa8d9449c9bbfbf569851a30b1e33df0b3f
ethevenot
parents: 0
diff changeset
1 Checking the formats of the dataMatrix, sampleMetadata, and variableMetadata files
e194eec8e70c planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 8ebfbfa8d9449c9bbfbf569851a30b1e33df0b3f
ethevenot
parents: 0
diff changeset
2 ==================================================================================
e194eec8e70c planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 8ebfbfa8d9449c9bbfbf569851a30b1e33df0b3f
ethevenot
parents: 0
diff changeset
3
e194eec8e70c planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 8ebfbfa8d9449c9bbfbf569851a30b1e33df0b3f
ethevenot
parents: 0
diff changeset
4 A Galaxy module from the [Workflow4metabolomics](http://workflow4metabolomics.org) infrastructure
0
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 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
7
0d8099822c49 planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 217d97da5c733c3628997666c73867e81af0a0ee
ethevenot
parents:
diff changeset
8 ### Description
0d8099822c49 planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 217d97da5c733c3628997666c73867e81af0a0ee
ethevenot
parents:
diff changeset
9
1
e194eec8e70c planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 8ebfbfa8d9449c9bbfbf569851a30b1e33df0b3f
ethevenot
parents: 0
diff changeset
10 **Version:** 2.0.4
0
0d8099822c49 planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 217d97da5c733c3628997666c73867e81af0a0ee
ethevenot
parents:
diff changeset
11 **Date:** 2016-07-29
0d8099822c49 planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 217d97da5c733c3628997666c73867e81af0a0ee
ethevenot
parents:
diff changeset
12 **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
13 **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
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)
0d8099822c49 planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 217d97da5c733c3628997666c73867e81af0a0ee
ethevenot
parents:
diff changeset
15 **Licence:** CeCILL
0d8099822c49 planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 217d97da5c733c3628997666c73867e81af0a0ee
ethevenot
parents:
diff changeset
16 **Reference histories:**
0d8099822c49 planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 217d97da5c733c3628997666c73867e81af0a0ee
ethevenot
parents:
diff changeset
17 [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
18 [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
19 **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
20
0d8099822c49 planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 217d97da5c733c3628997666c73867e81af0a0ee
ethevenot
parents:
diff changeset
21 ### Installation
0d8099822c49 planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 217d97da5c733c3628997666c73867e81af0a0ee
ethevenot
parents:
diff changeset
22
1
e194eec8e70c planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 8ebfbfa8d9449c9bbfbf569851a30b1e33df0b3f
ethevenot
parents: 0
diff changeset
23 * Configuration file: `checkformat_config.xml`
e194eec8e70c planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 8ebfbfa8d9449c9bbfbf569851a30b1e33df0b3f
ethevenot
parents: 0
diff changeset
24 * Image file: `static/images/checkformat_workflowPositionImage.png`
e194eec8e70c planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 8ebfbfa8d9449c9bbfbf569851a30b1e33df0b3f
ethevenot
parents: 0
diff changeset
25 * Wrapper file: `checkformat_wrapper.R`
0
0d8099822c49 planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 217d97da5c733c3628997666c73867e81af0a0ee
ethevenot
parents:
diff changeset
26 * R packages
1
e194eec8e70c planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 8ebfbfa8d9449c9bbfbf569851a30b1e33df0b3f
ethevenot
parents: 0
diff changeset
27 + **batch** from CRAN
e194eec8e70c planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 8ebfbfa8d9449c9bbfbf569851a30b1e33df0b3f
ethevenot
parents: 0
diff changeset
28
e194eec8e70c planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 8ebfbfa8d9449c9bbfbf569851a30b1e33df0b3f
ethevenot
parents: 0
diff changeset
29 ```r
e194eec8e70c planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 8ebfbfa8d9449c9bbfbf569851a30b1e33df0b3f
ethevenot
parents: 0
diff changeset
30 install.packages("batch", dep=TRUE)
e194eec8e70c planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 8ebfbfa8d9449c9bbfbf569851a30b1e33df0b3f
ethevenot
parents: 0
diff changeset
31 ```
0
0d8099822c49 planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 217d97da5c733c3628997666c73867e81af0a0ee
ethevenot
parents:
diff changeset
32
0d8099822c49 planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 217d97da5c733c3628997666c73867e81af0a0ee
ethevenot
parents:
diff changeset
33 ### Tests
0d8099822c49 planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 217d97da5c733c3628997666c73867e81af0a0ee
ethevenot
parents:
diff changeset
34
1
e194eec8e70c planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 8ebfbfa8d9449c9bbfbf569851a30b1e33df0b3f
ethevenot
parents: 0
diff changeset
35 The code in the wrapper can be tested by running the `runit/checkformat_tests.R` R file
e194eec8e70c planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 8ebfbfa8d9449c9bbfbf569851a30b1e33df0b3f
ethevenot
parents: 0
diff changeset
36
e194eec8e70c planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 8ebfbfa8d9449c9bbfbf569851a30b1e33df0b3f
ethevenot
parents: 0
diff changeset
37 You will need to install **RUnit** package in order to make it run:
e194eec8e70c planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 8ebfbfa8d9449c9bbfbf569851a30b1e33df0b3f
ethevenot
parents: 0
diff changeset
38 ```r
e194eec8e70c planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 8ebfbfa8d9449c9bbfbf569851a30b1e33df0b3f
ethevenot
parents: 0
diff changeset
39 install.packages('RUnit', dependencies = TRUE)
e194eec8e70c planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 8ebfbfa8d9449c9bbfbf569851a30b1e33df0b3f
ethevenot
parents: 0
diff changeset
40 ```
e194eec8e70c planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 8ebfbfa8d9449c9bbfbf569851a30b1e33df0b3f
ethevenot
parents: 0
diff changeset
41
e194eec8e70c planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 8ebfbfa8d9449c9bbfbf569851a30b1e33df0b3f
ethevenot
parents: 0
diff changeset
42 ### Working example
e194eec8e70c planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 8ebfbfa8d9449c9bbfbf569851a30b1e33df0b3f
ethevenot
parents: 0
diff changeset
43
e194eec8e70c planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 8ebfbfa8d9449c9bbfbf569851a30b1e33df0b3f
ethevenot
parents: 0
diff changeset
44 See the **W4M00001a_sacurine-subset-statistics**, **W4M00001b_sacurine-complete**, **W4M00002_mtbls2**, or **W4M00003_diaplasma** shared histories in the **Shared Data/Published Histories** menu (https://galaxy.workflow4metabolomics.org/history/list_published)
0
0d8099822c49 planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 217d97da5c733c3628997666c73867e81af0a0ee
ethevenot
parents:
diff changeset
45
0d8099822c49 planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 217d97da5c733c3628997666c73867e81af0a0ee
ethevenot
parents:
diff changeset
46 ### News
0d8099822c49 planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 217d97da5c733c3628997666c73867e81af0a0ee
ethevenot
parents:
diff changeset
47
1
e194eec8e70c planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 8ebfbfa8d9449c9bbfbf569851a30b1e33df0b3f
ethevenot
parents: 0
diff changeset
48 ##### CHANGES IN VERSION 2.0.4
e194eec8e70c planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 8ebfbfa8d9449c9bbfbf569851a30b1e33df0b3f
ethevenot
parents: 0
diff changeset
49
e194eec8e70c planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 8ebfbfa8d9449c9bbfbf569851a30b1e33df0b3f
ethevenot
parents: 0
diff changeset
50 INTERNAL MODIFICATION
e194eec8e70c planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 8ebfbfa8d9449c9bbfbf569851a30b1e33df0b3f
ethevenot
parents: 0
diff changeset
51
e194eec8e70c planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 8ebfbfa8d9449c9bbfbf569851a30b1e33df0b3f
ethevenot
parents: 0
diff changeset
52 * Minor internal modifications
e194eec8e70c planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 8ebfbfa8d9449c9bbfbf569851a30b1e33df0b3f
ethevenot
parents: 0
diff changeset
53
0
0d8099822c49 planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 217d97da5c733c3628997666c73867e81af0a0ee
ethevenot
parents:
diff changeset
54 ##### CHANGES IN VERSION 2.0.2
0d8099822c49 planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 217d97da5c733c3628997666c73867e81af0a0ee
ethevenot
parents:
diff changeset
55
0d8099822c49 planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 217d97da5c733c3628997666c73867e81af0a0ee
ethevenot
parents:
diff changeset
56 INTERNAL MODIFICATION
0d8099822c49 planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 217d97da5c733c3628997666c73867e81af0a0ee
ethevenot
parents:
diff changeset
57
1
e194eec8e70c planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit 8ebfbfa8d9449c9bbfbf569851a30b1e33df0b3f
ethevenot
parents: 0
diff changeset
58 * Creating tests for R code