diff README.md @ 1:e194eec8e70c draft

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
line wrap: on
line diff
--- a/README.md	Sat Jul 30 12:06:35 2016 -0400
+++ b/README.md	Sat Aug 06 11:54:28 2016 -0400
@@ -1,11 +1,13 @@
-## Checking the formats of the dataMatrix, sampleMetadata, and variableMetadata files  
-#### A Galaxy module from the [Workflow4metabolomics](http://workflow4metabolomics.org) project
+Checking the formats of the dataMatrix, sampleMetadata, and variableMetadata files  
+==================================================================================
+
+A Galaxy module from the [Workflow4metabolomics](http://workflow4metabolomics.org) infrastructure  
 
 Status: [![Build Status](https://travis-ci.org/workflow4metabolomics/checkformat.svg?branch=master)](https://travis-ci.org/workflow4metabolomics/checkformat).
 
 ### Description
 
-**Version:** 2.0.2  
+**Version:** 2.0.4  
 **Date:** 2016-07-29  
 **Author:** Etienne A. Thevenot (CEA, LIST, MetaboHUB, W4M Core Development Team)   
 **Email:** [etienne.thevenot(at)cea.fr](mailto:etienne.thevenot@cea.fr)  
@@ -18,23 +20,39 @@
 
 ### Installation
 
-* Configuration file: **checkFormat_config.xml**
-* Image file: **static/images/checkFormat_workflowPositionImage.png**   
-* Wrapper file: **checkFormat_wrapper.R**  
+* Configuration file: `checkformat_config.xml`
+* Image file: `static/images/checkformat_workflowPositionImage.png`   
+* Wrapper file: `checkformat_wrapper.R`  
 * R packages  
-    + **batch** from CRAN  
-> install.packages("batch", dep=TRUE)   
+    + **batch** from CRAN
+ 
+    ```r
+    install.packages("batch", dep=TRUE)  
+    ```
 
 ### Tests
 
-The code in the wrapper can be tested by running the **tests/checkFormat_tests.R** in R  
+The code in the wrapper can be tested by running the `runit/checkformat_tests.R` R file
+
+You will need to install **RUnit** package in order to make it run:
+```r
+install.packages('RUnit', dependencies = TRUE)
+```
+
+### Working example
+
+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)
 
 ### News
 
+##### CHANGES IN VERSION 2.0.4 
+
+INTERNAL MODIFICATION  
+
+ * Minor internal modifications  
+
 ##### CHANGES IN VERSION 2.0.2  
 
 INTERNAL MODIFICATION  
 
-    o Creating tests for R code  
-    
-***
\ No newline at end of file
+ * Creating tests for R code  
\ No newline at end of file