diff CorrTable/README.md @ 1:29ec7e3afdd4 draft

Uploaded
author melpetera
date Thu, 01 Aug 2019 11:30:58 -0400
parents
children 2173ad5e7750
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/CorrTable/README.md	Thu Aug 01 11:30:58 2019 -0400
@@ -0,0 +1,45 @@
+Between-table Correlation
+=======
+
+Metadata
+-----------
+
+ * **@name**: Between-table Correlation
+ * **@version**: 1.0.0
+ * **@authors**: Original code: Ophelie Barbet (PFEM - INRA) - Maintainer: Melanie Petera (PFEM - INRA - MetaboHUB)
+ * **@init date**: 2018, May
+ * **@main usage**: This tool builds a correlation table from two seperate tables, with filtering options and graphical outputs. 
+
+ 
+Context
+-----------
+
+This tool is provided as one of the [Workflow4Metabolomics](http://workflow4metabolomics.org) Galaxy instance statistical tools. 
+W4M is a French infrastructure providing software tools to process, analyse and annotate metabolomics data. 
+
+User interface is based on the Galaxy platform (homepage: https://galaxyproject.org/). It is an open, web-based platform for data intensive biomedical research. 
+Whether on the free public server or your own instance, you can perform, reproduce, and share complete analyses.
+
+ 
+Configuration
+-----------
+
+### Requirement:
+ * R software: version > 3.0.0 recommended
+ * Specific R libraries: 'batch', 'ggplot2' and 'reshape2' 
+
+
+Technical description
+-----------
+
+Main files:
+
+- Corr_Script_samples_row.R: R function (core script)
+- Corr_wrap.R: R script to link the main R function to inputs
+- Corr.xml: XML wrapper (interface for Galaxy)
+
+
+Services provided
+-----------
+
+ * Help and support: support@workflow4metabolomics.org