diff README.md @ 0:c135ba23a2a3 draft

planemo upload for repository https://github.com/workflow4metabolomics/profia.git commit a36b676325794a0930845401b2e8bd7090e7ca16
author ethevenot
date Sat, 22 Apr 2017 07:27:42 -0400
parents
children bc95bcb6ead0
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.md	Sat Apr 22 07:27:42 2017 -0400
@@ -0,0 +1,68 @@
+Preprocessing workflow for Flow Injection Analysis coupled to High-Resolution Mass Spectrometry data (FIA-HRMS)
+===============================================================================================================
+
+A Galaxy module from the [Workflow4metabolomics](http://workflow4metabolomics.org) infrastructure  
+
+Status: [![Build Status](https://travis-ci.org/workflow4metabolomics/profia.svg?branch=master)](https://travis-ci.org/workflow4metabolomics/profia).
+
+### Description
+
+**Version:** 3.0.2  
+**Date:** 2017-04-21     
+**Author:** Alexis Delabriere and Etienne A. Thevenot (CEA, LIST, MetaboHUB, W4M Core Development Team)   
+**Email:** [etienne.thevenot(at)cea.fr](mailto:etienne.thevenot@cea.fr)  
+**Citation:** Delabriere A., Hohenester U., Colsch B., Junot C., Fenaille F. and Thevenot E.A. proFIA: A data preprocessing workflow for Flow Injection Analysis coupled to High-Resolution Mass Spectrometry. *submitted*.   
+**Licence:** CeCILL  
+**Reference history:**      
+**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)
+
+### Installation
+
+* Configuration file: `profia_config.xml`
+* Image files: 
+  + `static/images/profia_workflowPositionImage.png`   
+  + `static/images/profia_workingExampleImage.png`
+* Wrapper file: `profia_wrapper.R`
+* R packages
+ + **batch** from CRAN  
+  
+    ```r
+    install.packages("batch", dep=TRUE)
+    install.packages("FNN", dep=TRUE)
+    install.packages("maxLik", dep=TRUE)
+    install.packages("minpack.lm", dep=TRUE)
+    install.packages("pracma", dep=TRUE)
+    ```
+  + **profia** from Bioconductor  
+  
+    ```r
+    source("http://www.bioconductor.org/biocLite.R")
+    biocLite("xcms")
+    biocLite("plasFIA")
+    biocLite("proFIA")
+    ```  
+
+### Tests
+
+The code in the wrapper can be tested by running the `runit/profia_runtests.R` R file
+
+You will need to install **RUnit** package in order to make it run:
+```r
+install.packages('RUnit', dependencies = TRUE)
+```
+
+### Working example  
+
+### News
+
+###### CHANGES IN VERSION 3.0.2  
+
+NEW FEATURE  
+
+ * Parallel processing  
+
+###### CHANGES IN VERSION 3.0.0  
+
+NEW FEATURE  
+
+ * Creation of the tool