annotate TableMerge/README.md @ 2:fb42f8b52942 draft default tip

Uploaded
author melpetera
date Thu, 14 Nov 2019 15:20:52 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
fb42f8b52942 Uploaded
melpetera
parents:
diff changeset
1 Table Merge
fb42f8b52942 Uploaded
melpetera
parents:
diff changeset
2 =======
fb42f8b52942 Uploaded
melpetera
parents:
diff changeset
3
fb42f8b52942 Uploaded
melpetera
parents:
diff changeset
4 Metadata
fb42f8b52942 Uploaded
melpetera
parents:
diff changeset
5 -----------
fb42f8b52942 Uploaded
melpetera
parents:
diff changeset
6
fb42f8b52942 Uploaded
melpetera
parents:
diff changeset
7 * **@name**: Table Merge
fb42f8b52942 Uploaded
melpetera
parents:
diff changeset
8 * **@version**: 1.0.1
fb42f8b52942 Uploaded
melpetera
parents:
diff changeset
9 * **@authors**: Melanie Petera (PFEM - INRA - MetaboHUB)
fb42f8b52942 Uploaded
melpetera
parents:
diff changeset
10 * **@init date**: 2015, June
fb42f8b52942 Uploaded
melpetera
parents:
diff changeset
11 * **@main usage**: This tool merges a data matrix file with a selected metadata file to obtain a single file.
fb42f8b52942 Uploaded
melpetera
parents:
diff changeset
12
fb42f8b52942 Uploaded
melpetera
parents:
diff changeset
13
fb42f8b52942 Uploaded
melpetera
parents:
diff changeset
14 Context
fb42f8b52942 Uploaded
melpetera
parents:
diff changeset
15 -----------
fb42f8b52942 Uploaded
melpetera
parents:
diff changeset
16
fb42f8b52942 Uploaded
melpetera
parents:
diff changeset
17 This tool is provided as one of the [Workflow4Metabolomics](http://workflow4metabolomics.org) Galaxy instance statistical tools.
fb42f8b52942 Uploaded
melpetera
parents:
diff changeset
18 W4M is a French infrastructure providing software tools to process, analyse and annotate metabolomics data.
fb42f8b52942 Uploaded
melpetera
parents:
diff changeset
19
fb42f8b52942 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.
fb42f8b52942 Uploaded
melpetera
parents:
diff changeset
21 Whether on the free public server or your own instance, you can perform, reproduce, and share complete analyses.
fb42f8b52942 Uploaded
melpetera
parents:
diff changeset
22
fb42f8b52942 Uploaded
melpetera
parents:
diff changeset
23
fb42f8b52942 Uploaded
melpetera
parents:
diff changeset
24 Configuration
fb42f8b52942 Uploaded
melpetera
parents:
diff changeset
25 -----------
fb42f8b52942 Uploaded
melpetera
parents:
diff changeset
26
fb42f8b52942 Uploaded
melpetera
parents:
diff changeset
27 ### Requirement:
fb42f8b52942 Uploaded
melpetera
parents:
diff changeset
28 * R software: version > 3.0.0 recommended
fb42f8b52942 Uploaded
melpetera
parents:
diff changeset
29 * Specific R libraries: 'batch'
fb42f8b52942 Uploaded
melpetera
parents:
diff changeset
30
fb42f8b52942 Uploaded
melpetera
parents:
diff changeset
31
fb42f8b52942 Uploaded
melpetera
parents:
diff changeset
32 Technical description
fb42f8b52942 Uploaded
melpetera
parents:
diff changeset
33 -----------
fb42f8b52942 Uploaded
melpetera
parents:
diff changeset
34
fb42f8b52942 Uploaded
melpetera
parents:
diff changeset
35 Main files:
fb42f8b52942 Uploaded
melpetera
parents:
diff changeset
36
fb42f8b52942 Uploaded
melpetera
parents:
diff changeset
37 - tablemerge_script.R: R function (core script)
fb42f8b52942 Uploaded
melpetera
parents:
diff changeset
38 - tablemerge_wrap.R: R script to link the main R function to inputs
fb42f8b52942 Uploaded
melpetera
parents:
diff changeset
39 - tablemerge.xml: XML wrapper (interface for Galaxy)
fb42f8b52942 Uploaded
melpetera
parents:
diff changeset
40 - RcheckLibrary.R and miniTools.R: additional R functions used by the core script (input checks and data handling)
fb42f8b52942 Uploaded
melpetera
parents:
diff changeset
41
fb42f8b52942 Uploaded
melpetera
parents:
diff changeset
42
fb42f8b52942 Uploaded
melpetera
parents:
diff changeset
43 Services provided
fb42f8b52942 Uploaded
melpetera
parents:
diff changeset
44 -----------
fb42f8b52942 Uploaded
melpetera
parents:
diff changeset
45
fb42f8b52942 Uploaded
melpetera
parents:
diff changeset
46 * Help and support: support@workflow4metabolomics.org
fb42f8b52942 Uploaded
melpetera
parents:
diff changeset
47
fb42f8b52942 Uploaded
melpetera
parents:
diff changeset
48
fb42f8b52942 Uploaded
melpetera
parents:
diff changeset
49 License
fb42f8b52942 Uploaded
melpetera
parents:
diff changeset
50 -----------
fb42f8b52942 Uploaded
melpetera
parents:
diff changeset
51
fb42f8b52942 Uploaded
melpetera
parents:
diff changeset
52 * Cea Cnrs Inria Logiciel Libre License, version 2.1 (CECILL-2.1)