Mercurial > repos > ethevenot > profia

annotate README.md @ 2:3f8ae071bdda 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/profia.git commit 19ed25c048232776369a392ddb8c1860471acd29
author ethevenot
date Mon, 22 Jan 2018 11:32:41 -0500
parents 4753e64cf694
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
39ccace77270 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 2757590af8c7ba9833ba3bebd7da7f96b20d1128-dirty
ethevenot
parents:
diff changeset
1 Preprocessing workflow for Flow Injection Analysis coupled to High-Resolution Mass Spectrometry data (FIA-HRMS)
39ccace77270 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 2757590af8c7ba9833ba3bebd7da7f96b20d1128-dirty
ethevenot
parents:
diff changeset
2 ===============================================================================================================
39ccace77270 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 2757590af8c7ba9833ba3bebd7da7f96b20d1128-dirty
ethevenot
parents:
diff changeset
3
39ccace77270 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 2757590af8c7ba9833ba3bebd7da7f96b20d1128-dirty
ethevenot
parents:
diff changeset
4 A Galaxy module from the [Workflow4metabolomics](http://workflow4metabolomics.org) infrastructure
39ccace77270 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 2757590af8c7ba9833ba3bebd7da7f96b20d1128-dirty
ethevenot
parents:
diff changeset
5
39ccace77270 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 2757590af8c7ba9833ba3bebd7da7f96b20d1128-dirty
ethevenot
parents:
diff changeset
6 Status: [![Build Status](https://travis-ci.org/workflow4metabolomics/profia.svg?branch=master)](https://travis-ci.org/workflow4metabolomics/profia).
39ccace77270 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 2757590af8c7ba9833ba3bebd7da7f96b20d1128-dirty
ethevenot
parents:
diff changeset
7
39ccace77270 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 2757590af8c7ba9833ba3bebd7da7f96b20d1128-dirty
ethevenot
parents:
diff changeset
8 ### Description
39ccace77270 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 2757590af8c7ba9833ba3bebd7da7f96b20d1128-dirty
ethevenot
parents:
diff changeset
9
2
3f8ae071bdda planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 19ed25c048232776369a392ddb8c1860471acd29
ethevenot
parents: 1
diff changeset
10 **Version:** 3.1.0
3f8ae071bdda planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 19ed25c048232776369a392ddb8c1860471acd29
ethevenot
parents: 1
diff changeset
11 **Date:** 2018-01-08
0
39ccace77270 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 2757590af8c7ba9833ba3bebd7da7f96b20d1128-dirty
ethevenot
parents:
diff changeset
12 **Author:** Alexis Delabriere and Etienne A. Thevenot (CEA, LIST, MetaboHUB, W4M Core Development Team)
39ccace77270 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 2757590af8c7ba9833ba3bebd7da7f96b20d1128-dirty
ethevenot
parents:
diff changeset
13 **Email:** [etienne.thevenot(at)cea.fr](mailto:etienne.thevenot@cea.fr)
2
3f8ae071bdda planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 19ed25c048232776369a392ddb8c1860471acd29
ethevenot
parents: 1
diff changeset
14 **Citation:** Delabriere A., Hohenester U., Colsch B., Junot C., Fenaille F. and Thevenot E.A. (2017). proFIA: A data preprocessing workflow for Flow Injection Analysis coupled to High-Resolution Mass Spectrometry. *Bioinformatics*, 33:3767-3775 (https://doi.org/10.1093/bioinformatics/btx458).
0
39ccace77270 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 2757590af8c7ba9833ba3bebd7da7f96b20d1128-dirty
ethevenot
parents:
diff changeset
15 **Licence:** CeCILL
39ccace77270 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 2757590af8c7ba9833ba3bebd7da7f96b20d1128-dirty
ethevenot
parents:
diff changeset
16 **Reference history:**
39ccace77270 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 2757590af8c7ba9833ba3bebd7da7f96b20d1128-dirty
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)
39ccace77270 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 2757590af8c7ba9833ba3bebd7da7f96b20d1128-dirty
ethevenot
parents:
diff changeset
18
39ccace77270 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 2757590af8c7ba9833ba3bebd7da7f96b20d1128-dirty
ethevenot
parents:
diff changeset
19 ### Installation
39ccace77270 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 2757590af8c7ba9833ba3bebd7da7f96b20d1128-dirty
ethevenot
parents:
diff changeset
20
39ccace77270 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 2757590af8c7ba9833ba3bebd7da7f96b20d1128-dirty
ethevenot
parents:
diff changeset
21 * Configuration file: `profia_config.xml`
39ccace77270 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 2757590af8c7ba9833ba3bebd7da7f96b20d1128-dirty
ethevenot
parents:
diff changeset
22 * Image files:
39ccace77270 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 2757590af8c7ba9833ba3bebd7da7f96b20d1128-dirty
ethevenot
parents:
diff changeset
23 + `static/images/profia_workflowPositionImage.png`
39ccace77270 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 2757590af8c7ba9833ba3bebd7da7f96b20d1128-dirty
ethevenot
parents:
diff changeset
24 + `static/images/profia_workingExampleImage.png`
39ccace77270 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 2757590af8c7ba9833ba3bebd7da7f96b20d1128-dirty
ethevenot
parents:
diff changeset
25 * Wrapper file: `profia_wrapper.R`
39ccace77270 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 2757590af8c7ba9833ba3bebd7da7f96b20d1128-dirty
ethevenot
parents:
diff changeset
26 * R packages
39ccace77270 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 2757590af8c7ba9833ba3bebd7da7f96b20d1128-dirty
ethevenot
parents:
diff changeset
27 + **batch** from CRAN
39ccace77270 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 2757590af8c7ba9833ba3bebd7da7f96b20d1128-dirty
ethevenot
parents:
diff changeset
28
39ccace77270 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 2757590af8c7ba9833ba3bebd7da7f96b20d1128-dirty
ethevenot
parents:
diff changeset
29 ```r
39ccace77270 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 2757590af8c7ba9833ba3bebd7da7f96b20d1128-dirty
ethevenot
parents:
diff changeset
30 install.packages("batch", dep=TRUE)
39ccace77270 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 2757590af8c7ba9833ba3bebd7da7f96b20d1128-dirty
ethevenot
parents:
diff changeset
31 install.packages("minpack.lm", dep=TRUE)
2
3f8ae071bdda planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 19ed25c048232776369a392ddb8c1860471acd29
ethevenot
parents: 1
diff changeset
32 install.packages("missForest", dep=TRUE)
0
39ccace77270 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 2757590af8c7ba9833ba3bebd7da7f96b20d1128-dirty
ethevenot
parents:
diff changeset
33 install.packages("pracma", dep=TRUE)
39ccace77270 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 2757590af8c7ba9833ba3bebd7da7f96b20d1128-dirty
ethevenot
parents:
diff changeset
34 ```
39ccace77270 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 2757590af8c7ba9833ba3bebd7da7f96b20d1128-dirty
ethevenot
parents:
diff changeset
35 + **profia** from Bioconductor
39ccace77270 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 2757590af8c7ba9833ba3bebd7da7f96b20d1128-dirty
ethevenot
parents:
diff changeset
36
39ccace77270 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 2757590af8c7ba9833ba3bebd7da7f96b20d1128-dirty
ethevenot
parents:
diff changeset
37 ```r
39ccace77270 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 2757590af8c7ba9833ba3bebd7da7f96b20d1128-dirty
ethevenot
parents:
diff changeset
38 source("http://www.bioconductor.org/biocLite.R")
2
3f8ae071bdda planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 19ed25c048232776369a392ddb8c1860471acd29
ethevenot
parents: 1
diff changeset
39 biocLite("Biobase")
3f8ae071bdda planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 19ed25c048232776369a392ddb8c1860471acd29
ethevenot
parents: 1
diff changeset
40 biocLite("BiocParallel")
0
39ccace77270 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 2757590af8c7ba9833ba3bebd7da7f96b20d1128-dirty
ethevenot
parents:
diff changeset
41 biocLite("xcms")
1
4753e64cf694 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 0a90b8ee1577263ace397124d8b0e34d1e630f51
ethevenot
parents: 0
diff changeset
42 biocLite("plasFIA")
0
39ccace77270 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 2757590af8c7ba9833ba3bebd7da7f96b20d1128-dirty
ethevenot
parents:
diff changeset
43 biocLite("proFIA")
39ccace77270 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 2757590af8c7ba9833ba3bebd7da7f96b20d1128-dirty
ethevenot
parents:
diff changeset
44 ```
39ccace77270 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 2757590af8c7ba9833ba3bebd7da7f96b20d1128-dirty
ethevenot
parents:
diff changeset
45
39ccace77270 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 2757590af8c7ba9833ba3bebd7da7f96b20d1128-dirty
ethevenot
parents:
diff changeset
46 ### Tests
39ccace77270 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 2757590af8c7ba9833ba3bebd7da7f96b20d1128-dirty
ethevenot
parents:
diff changeset
47
39ccace77270 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 2757590af8c7ba9833ba3bebd7da7f96b20d1128-dirty
ethevenot
parents:
diff changeset
48 The code in the wrapper can be tested by running the `runit/profia_runtests.R` R file
39ccace77270 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 2757590af8c7ba9833ba3bebd7da7f96b20d1128-dirty
ethevenot
parents:
diff changeset
49
39ccace77270 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 2757590af8c7ba9833ba3bebd7da7f96b20d1128-dirty
ethevenot
parents:
diff changeset
50 You will need to install **RUnit** package in order to make it run:
39ccace77270 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 2757590af8c7ba9833ba3bebd7da7f96b20d1128-dirty
ethevenot
parents:
diff changeset
51 ```r
39ccace77270 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 2757590af8c7ba9833ba3bebd7da7f96b20d1128-dirty
ethevenot
parents:
diff changeset
52 install.packages('RUnit', dependencies = TRUE)
39ccace77270 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 2757590af8c7ba9833ba3bebd7da7f96b20d1128-dirty
ethevenot
parents:
diff changeset
53 ```
39ccace77270 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 2757590af8c7ba9833ba3bebd7da7f96b20d1128-dirty
ethevenot
parents:
diff changeset
54
39ccace77270 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 2757590af8c7ba9833ba3bebd7da7f96b20d1128-dirty
ethevenot
parents:
diff changeset
55 ### Working example
39ccace77270 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 2757590af8c7ba9833ba3bebd7da7f96b20d1128-dirty
ethevenot
parents:
diff changeset
56
1
4753e64cf694 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 0a90b8ee1577263ace397124d8b0e34d1e630f51
ethevenot
parents: 0
diff changeset
57 ### News
4753e64cf694 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 0a90b8ee1577263ace397124d8b0e34d1e630f51
ethevenot
parents: 0
diff changeset
58
2
3f8ae071bdda planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 19ed25c048232776369a392ddb8c1860471acd29
ethevenot
parents: 1
diff changeset
59 ###### CHANGES IN VERSION 3.1.0
3f8ae071bdda planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 19ed25c048232776369a392ddb8c1860471acd29
ethevenot
parents: 1
diff changeset
60
3f8ae071bdda planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 19ed25c048232776369a392ddb8c1860471acd29
ethevenot
parents: 1
diff changeset
61 NEW FEATURE
3f8ae071bdda planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 19ed25c048232776369a392ddb8c1860471acd29
ethevenot
parents: 1
diff changeset
62
3f8ae071bdda planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 19ed25c048232776369a392ddb8c1860471acd29
ethevenot
parents: 1
diff changeset
63 randomForest method implemented for imputation of missing values
3f8ae071bdda planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 19ed25c048232776369a392ddb8c1860471acd29
ethevenot
parents: 1
diff changeset
64
3f8ae071bdda planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 19ed25c048232776369a392ddb8c1860471acd29
ethevenot
parents: 1
diff changeset
65 ###### CHANGES IN VERSION 3.0.6
3f8ae071bdda planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 19ed25c048232776369a392ddb8c1860471acd29
ethevenot
parents: 1
diff changeset
66
3f8ae071bdda planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 19ed25c048232776369a392ddb8c1860471acd29
ethevenot
parents: 1
diff changeset
67 NEW FEATURES
3f8ae071bdda planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 19ed25c048232776369a392ddb8c1860471acd29
ethevenot
parents: 1
diff changeset
68
3f8ae071bdda planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 19ed25c048232776369a392ddb8c1860471acd29
ethevenot
parents: 1
diff changeset
69 * New (advanced) parameters available
3f8ae071bdda planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 19ed25c048232776369a392ddb8c1860471acd29
ethevenot
parents: 1
diff changeset
70
1
4753e64cf694 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 0a90b8ee1577263ace397124d8b0e34d1e630f51
ethevenot
parents: 0
diff changeset
71 ###### CHANGES IN VERSION 3.0.4
4753e64cf694 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 0a90b8ee1577263ace397124d8b0e34d1e630f51
ethevenot
parents: 0
diff changeset
72
4753e64cf694 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 0a90b8ee1577263ace397124d8b0e34d1e630f51
ethevenot
parents: 0
diff changeset
73 MINOR MODIFICATION
4753e64cf694 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 0a90b8ee1577263ace397124d8b0e34d1e630f51
ethevenot
parents: 0
diff changeset
74
4753e64cf694 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 0a90b8ee1577263ace397124d8b0e34d1e630f51
ethevenot
parents: 0
diff changeset
75 * Details added in the documentation
4753e64cf694 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 0a90b8ee1577263ace397124d8b0e34d1e630f51
ethevenot
parents: 0
diff changeset
76
4753e64cf694 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 0a90b8ee1577263ace397124d8b0e34d1e630f51
ethevenot
parents: 0
diff changeset
77 ###### CHANGES IN VERSION 3.0.2
4753e64cf694 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 0a90b8ee1577263ace397124d8b0e34d1e630f51
ethevenot
parents: 0
diff changeset
78
4753e64cf694 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 0a90b8ee1577263ace397124d8b0e34d1e630f51
ethevenot
parents: 0
diff changeset
79 NEW FEATURE
4753e64cf694 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 0a90b8ee1577263ace397124d8b0e34d1e630f51
ethevenot
parents: 0
diff changeset
80
4753e64cf694 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 0a90b8ee1577263ace397124d8b0e34d1e630f51
ethevenot
parents: 0
diff changeset
81 * Parallel processing
0
39ccace77270 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 2757590af8c7ba9833ba3bebd7da7f96b20d1128-dirty
ethevenot
parents:
diff changeset
82
39ccace77270 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 2757590af8c7ba9833ba3bebd7da7f96b20d1128-dirty
ethevenot
parents:
diff changeset
83 ###### CHANGES IN VERSION 3.0.0
39ccace77270 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 2757590af8c7ba9833ba3bebd7da7f96b20d1128-dirty
ethevenot
parents:
diff changeset
84
39ccace77270 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 2757590af8c7ba9833ba3bebd7da7f96b20d1128-dirty
ethevenot
parents:
diff changeset
85 NEW FEATURE
39ccace77270 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 2757590af8c7ba9833ba3bebd7da7f96b20d1128-dirty
ethevenot
parents:
diff changeset
86
39ccace77270 planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit 2757590af8c7ba9833ba3bebd7da7f96b20d1128-dirty
ethevenot
parents:
diff changeset
87 * Creation of the tool