Mercurial > repos > ethevenot > checkformat

annotate README.md @ 0:059eb452931e 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 e17f78630b4d21b54a4edd6015d50969ac859d6b
author ethevenot
date Tue, 24 Oct 2017 08:44:02 -0400
parents
children b642f4f87022
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
059eb452931e planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit e17f78630b4d21b54a4edd6015d50969ac859d6b
ethevenot
parents:
diff changeset
1 Checking the formats of the dataMatrix, sampleMetadata, and variableMetadata files
059eb452931e planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit e17f78630b4d21b54a4edd6015d50969ac859d6b
ethevenot
parents:
diff changeset
2 ==================================================================================
059eb452931e planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit e17f78630b4d21b54a4edd6015d50969ac859d6b
ethevenot
parents:
diff changeset
3
059eb452931e planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit e17f78630b4d21b54a4edd6015d50969ac859d6b
ethevenot
parents:
diff changeset
4 A Galaxy module from the [Workflow4metabolomics](http://workflow4metabolomics.org) infrastructure
059eb452931e planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit e17f78630b4d21b54a4edd6015d50969ac859d6b
ethevenot
parents:
diff changeset
5
059eb452931e planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit e17f78630b4d21b54a4edd6015d50969ac859d6b
ethevenot
parents:
diff changeset
6 Status: [![Build Status](https://travis-ci.org/workflow4metabolomics/checkformat.svg?branch=master)](https://travis-ci.org/workflow4metabolomics/checkformat).
059eb452931e planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit e17f78630b4d21b54a4edd6015d50969ac859d6b
ethevenot
parents:
diff changeset
7
059eb452931e planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit e17f78630b4d21b54a4edd6015d50969ac859d6b
ethevenot
parents:
diff changeset
8 ### Description
059eb452931e planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit e17f78630b4d21b54a4edd6015d50969ac859d6b
ethevenot
parents:
diff changeset
9
059eb452931e planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit e17f78630b4d21b54a4edd6015d50969ac859d6b
ethevenot
parents:
diff changeset
10 **Version:** 2.0.4
059eb452931e planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit e17f78630b4d21b54a4edd6015d50969ac859d6b
ethevenot
parents:
diff changeset
11 **Date:** 2016-07-29
059eb452931e planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit e17f78630b4d21b54a4edd6015d50969ac859d6b
ethevenot
parents:
diff changeset
12 **Author:** Etienne A. Thevenot (CEA, LIST, MetaboHUB, W4M Core Development Team)
059eb452931e planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit e17f78630b4d21b54a4edd6015d50969ac859d6b
ethevenot
parents:
diff changeset
13 **Email:** [etienne.thevenot(at)cea.fr](mailto:etienne.thevenot@cea.fr)
059eb452931e planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit e17f78630b4d21b54a4edd6015d50969ac859d6b
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)
059eb452931e planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit e17f78630b4d21b54a4edd6015d50969ac859d6b
ethevenot
parents:
diff changeset
15 **Licence:** CeCILL
059eb452931e planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit e17f78630b4d21b54a4edd6015d50969ac859d6b
ethevenot
parents:
diff changeset
16 **Reference histories:**
059eb452931e planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit e17f78630b4d21b54a4edd6015d50969ac859d6b
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),
059eb452931e planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit e17f78630b4d21b54a4edd6015d50969ac859d6b
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)
059eb452931e planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit e17f78630b4d21b54a4edd6015d50969ac859d6b
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)
059eb452931e planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit e17f78630b4d21b54a4edd6015d50969ac859d6b
ethevenot
parents:
diff changeset
20
059eb452931e planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit e17f78630b4d21b54a4edd6015d50969ac859d6b
ethevenot
parents:
diff changeset
21 ### Installation
059eb452931e planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit e17f78630b4d21b54a4edd6015d50969ac859d6b
ethevenot
parents:
diff changeset
22
059eb452931e planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit e17f78630b4d21b54a4edd6015d50969ac859d6b
ethevenot
parents:
diff changeset
23 * Configuration file: `checkformat_config.xml`
059eb452931e planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit e17f78630b4d21b54a4edd6015d50969ac859d6b
ethevenot
parents:
diff changeset
24 * Image file: `static/images/checkformat_workflowPositionImage.png`
059eb452931e planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit e17f78630b4d21b54a4edd6015d50969ac859d6b
ethevenot
parents:
diff changeset
25 * Wrapper file: `checkformat_wrapper.R`
059eb452931e planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit e17f78630b4d21b54a4edd6015d50969ac859d6b
ethevenot
parents:
diff changeset
26 * R packages
059eb452931e planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit e17f78630b4d21b54a4edd6015d50969ac859d6b
ethevenot
parents:
diff changeset
27 + **batch** from CRAN
059eb452931e planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit e17f78630b4d21b54a4edd6015d50969ac859d6b
ethevenot
parents:
diff changeset
28
059eb452931e planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit e17f78630b4d21b54a4edd6015d50969ac859d6b
ethevenot
parents:
diff changeset
29 ```r
059eb452931e planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit e17f78630b4d21b54a4edd6015d50969ac859d6b
ethevenot
parents:
diff changeset
30 install.packages("batch", dep=TRUE)
059eb452931e planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit e17f78630b4d21b54a4edd6015d50969ac859d6b
ethevenot
parents:
diff changeset
31 ```
059eb452931e planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit e17f78630b4d21b54a4edd6015d50969ac859d6b
ethevenot
parents:
diff changeset
32
059eb452931e planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit e17f78630b4d21b54a4edd6015d50969ac859d6b
ethevenot
parents:
diff changeset
33 ### Tests
059eb452931e planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit e17f78630b4d21b54a4edd6015d50969ac859d6b
ethevenot
parents:
diff changeset
34
059eb452931e planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit e17f78630b4d21b54a4edd6015d50969ac859d6b
ethevenot
parents:
diff changeset
35 The code in the wrapper can be tested by running the `runit/checkformat_tests.R` R file
059eb452931e planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit e17f78630b4d21b54a4edd6015d50969ac859d6b
ethevenot
parents:
diff changeset
36
059eb452931e planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit e17f78630b4d21b54a4edd6015d50969ac859d6b
ethevenot
parents:
diff changeset
37 You will need to install **RUnit** package in order to make it run:
059eb452931e planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit e17f78630b4d21b54a4edd6015d50969ac859d6b
ethevenot
parents:
diff changeset
38 ```r
059eb452931e planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit e17f78630b4d21b54a4edd6015d50969ac859d6b
ethevenot
parents:
diff changeset
39 install.packages('RUnit', dependencies = TRUE)
059eb452931e planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit e17f78630b4d21b54a4edd6015d50969ac859d6b
ethevenot
parents:
diff changeset
40 ```
059eb452931e planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit e17f78630b4d21b54a4edd6015d50969ac859d6b
ethevenot
parents:
diff changeset
41
059eb452931e planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit e17f78630b4d21b54a4edd6015d50969ac859d6b
ethevenot
parents:
diff changeset
42 ### Working example
059eb452931e planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit e17f78630b4d21b54a4edd6015d50969ac859d6b
ethevenot
parents:
diff changeset
43
059eb452931e planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit e17f78630b4d21b54a4edd6015d50969ac859d6b
ethevenot
parents:
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)
059eb452931e planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit e17f78630b4d21b54a4edd6015d50969ac859d6b
ethevenot
parents:
diff changeset
45
059eb452931e planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit e17f78630b4d21b54a4edd6015d50969ac859d6b
ethevenot
parents:
diff changeset
46 ### News
059eb452931e planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit e17f78630b4d21b54a4edd6015d50969ac859d6b
ethevenot
parents:
diff changeset
47
059eb452931e planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit e17f78630b4d21b54a4edd6015d50969ac859d6b
ethevenot
parents:
diff changeset
48 ##### CHANGES IN VERSION 2.0.4
059eb452931e planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit e17f78630b4d21b54a4edd6015d50969ac859d6b
ethevenot
parents:
diff changeset
49
059eb452931e planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit e17f78630b4d21b54a4edd6015d50969ac859d6b
ethevenot
parents:
diff changeset
50 INTERNAL MODIFICATION
059eb452931e planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit e17f78630b4d21b54a4edd6015d50969ac859d6b
ethevenot
parents:
diff changeset
51
059eb452931e planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit e17f78630b4d21b54a4edd6015d50969ac859d6b
ethevenot
parents:
diff changeset
52 * Minor internal modifications
059eb452931e planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit e17f78630b4d21b54a4edd6015d50969ac859d6b
ethevenot
parents:
diff changeset
53
059eb452931e planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit e17f78630b4d21b54a4edd6015d50969ac859d6b
ethevenot
parents:
diff changeset
54 ##### CHANGES IN VERSION 2.0.2
059eb452931e planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit e17f78630b4d21b54a4edd6015d50969ac859d6b
ethevenot
parents:
diff changeset
55
059eb452931e planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit e17f78630b4d21b54a4edd6015d50969ac859d6b
ethevenot
parents:
diff changeset
56 INTERNAL MODIFICATION
059eb452931e planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit e17f78630b4d21b54a4edd6015d50969ac859d6b
ethevenot
parents:
diff changeset
57
059eb452931e planemo upload for repository https://github.com/workflow4metabolomics/checkformat.git commit e17f78630b4d21b54a4edd6015d50969ac859d6b
ethevenot
parents:
diff changeset
58 * Creating tests for R code