annotate CorrTable/README.md @ 2:2173ad5e7750 draft default tip

Uploaded
author melpetera
date Wed, 16 Oct 2019 03:12:55 -0400
parents 29ec7e3afdd4
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
29ec7e3afdd4 Uploaded
melpetera
parents:
diff changeset
1 Between-table Correlation
29ec7e3afdd4 Uploaded
melpetera
parents:
diff changeset
2 =======
29ec7e3afdd4 Uploaded
melpetera
parents:
diff changeset
3
29ec7e3afdd4 Uploaded
melpetera
parents:
diff changeset
4 Metadata
29ec7e3afdd4 Uploaded
melpetera
parents:
diff changeset
5 -----------
29ec7e3afdd4 Uploaded
melpetera
parents:
diff changeset
6
29ec7e3afdd4 Uploaded
melpetera
parents:
diff changeset
7 * **@name**: Between-table Correlation
29ec7e3afdd4 Uploaded
melpetera
parents:
diff changeset
8 * **@version**: 1.0.0
29ec7e3afdd4 Uploaded
melpetera
parents:
diff changeset
9 * **@authors**: Original code: Ophelie Barbet (PFEM - INRA) - Maintainer: Melanie Petera (PFEM - INRA - MetaboHUB)
29ec7e3afdd4 Uploaded
melpetera
parents:
diff changeset
10 * **@init date**: 2018, May
29ec7e3afdd4 Uploaded
melpetera
parents:
diff changeset
11 * **@main usage**: This tool builds a correlation table from two seperate tables, with filtering options and graphical outputs.
29ec7e3afdd4 Uploaded
melpetera
parents:
diff changeset
12
29ec7e3afdd4 Uploaded
melpetera
parents:
diff changeset
13
29ec7e3afdd4 Uploaded
melpetera
parents:
diff changeset
14 Context
29ec7e3afdd4 Uploaded
melpetera
parents:
diff changeset
15 -----------
29ec7e3afdd4 Uploaded
melpetera
parents:
diff changeset
16
29ec7e3afdd4 Uploaded
melpetera
parents:
diff changeset
17 This tool is provided as one of the [Workflow4Metabolomics](http://workflow4metabolomics.org) Galaxy instance statistical tools.
29ec7e3afdd4 Uploaded
melpetera
parents:
diff changeset
18 W4M is a French infrastructure providing software tools to process, analyse and annotate metabolomics data.
29ec7e3afdd4 Uploaded
melpetera
parents:
diff changeset
19
29ec7e3afdd4 Uploaded
melpetera
parents:
diff changeset
20 User interface is based on the Galaxy platform (homepage: https://galaxyproject.org/). It is an open, web-based platform for data intensive biomedical research.
29ec7e3afdd4 Uploaded
melpetera
parents:
diff changeset
21 Whether on the free public server or your own instance, you can perform, reproduce, and share complete analyses.
29ec7e3afdd4 Uploaded
melpetera
parents:
diff changeset
22
29ec7e3afdd4 Uploaded
melpetera
parents:
diff changeset
23
29ec7e3afdd4 Uploaded
melpetera
parents:
diff changeset
24 Configuration
29ec7e3afdd4 Uploaded
melpetera
parents:
diff changeset
25 -----------
29ec7e3afdd4 Uploaded
melpetera
parents:
diff changeset
26
29ec7e3afdd4 Uploaded
melpetera
parents:
diff changeset
27 ### Requirement:
29ec7e3afdd4 Uploaded
melpetera
parents:
diff changeset
28 * R software: version > 3.0.0 recommended
29ec7e3afdd4 Uploaded
melpetera
parents:
diff changeset
29 * Specific R libraries: 'batch', 'ggplot2' and 'reshape2'
29ec7e3afdd4 Uploaded
melpetera
parents:
diff changeset
30
29ec7e3afdd4 Uploaded
melpetera
parents:
diff changeset
31
29ec7e3afdd4 Uploaded
melpetera
parents:
diff changeset
32 Technical description
29ec7e3afdd4 Uploaded
melpetera
parents:
diff changeset
33 -----------
29ec7e3afdd4 Uploaded
melpetera
parents:
diff changeset
34
29ec7e3afdd4 Uploaded
melpetera
parents:
diff changeset
35 Main files:
29ec7e3afdd4 Uploaded
melpetera
parents:
diff changeset
36
29ec7e3afdd4 Uploaded
melpetera
parents:
diff changeset
37 - Corr_Script_samples_row.R: R function (core script)
29ec7e3afdd4 Uploaded
melpetera
parents:
diff changeset
38 - Corr_wrap.R: R script to link the main R function to inputs
29ec7e3afdd4 Uploaded
melpetera
parents:
diff changeset
39 - Corr.xml: XML wrapper (interface for Galaxy)
29ec7e3afdd4 Uploaded
melpetera
parents:
diff changeset
40
29ec7e3afdd4 Uploaded
melpetera
parents:
diff changeset
41
29ec7e3afdd4 Uploaded
melpetera
parents:
diff changeset
42 Services provided
29ec7e3afdd4 Uploaded
melpetera
parents:
diff changeset
43 -----------
29ec7e3afdd4 Uploaded
melpetera
parents:
diff changeset
44
29ec7e3afdd4 Uploaded
melpetera
parents:
diff changeset
45 * Help and support: support@workflow4metabolomics.org
2
2173ad5e7750 Uploaded
melpetera
parents: 1
diff changeset
46
2173ad5e7750 Uploaded
melpetera
parents: 1
diff changeset
47
2173ad5e7750 Uploaded
melpetera
parents: 1
diff changeset
48 License
2173ad5e7750 Uploaded
melpetera
parents: 1
diff changeset
49 -----------
2173ad5e7750 Uploaded
melpetera
parents: 1
diff changeset
50
2173ad5e7750 Uploaded
melpetera
parents: 1
diff changeset
51 * Cea Cnrs Inria Logiciel Libre License, version 2.1 (CECILL-2.1)