annotate IDchoice/README.md @ 1:bb19b1d15732 draft default tip

Uploaded
author melpetera
date Thu, 19 Dec 2019 05:29:57 -0500
parents b7a6a88f518a
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
b7a6a88f518a Uploaded
melpetera
parents:
diff changeset
1 ID choice
b7a6a88f518a Uploaded
melpetera
parents:
diff changeset
2 =======
b7a6a88f518a Uploaded
melpetera
parents:
diff changeset
3
b7a6a88f518a Uploaded
melpetera
parents:
diff changeset
4 Metadata
b7a6a88f518a Uploaded
melpetera
parents:
diff changeset
5 -----------
b7a6a88f518a Uploaded
melpetera
parents:
diff changeset
6
b7a6a88f518a Uploaded
melpetera
parents:
diff changeset
7 * **@name**: ID choice
1
bb19b1d15732 Uploaded
melpetera
parents: 0
diff changeset
8 * **@version**: 19.12
0
b7a6a88f518a Uploaded
melpetera
parents:
diff changeset
9 * **@authors**: Melanie Petera - PFEM ; INRA ; MetaboHUB
b7a6a88f518a Uploaded
melpetera
parents:
diff changeset
10 * **@init date**: 2017/06/07
b7a6a88f518a Uploaded
melpetera
parents:
diff changeset
11 * **@main usage**: This tool is designed to make you choose a particular column in your metadata file to be considered as identifiers for your W4M-3-tables-format data.
b7a6a88f518a Uploaded
melpetera
parents:
diff changeset
12
b7a6a88f518a Uploaded
melpetera
parents:
diff changeset
13
b7a6a88f518a Uploaded
melpetera
parents:
diff changeset
14 Context
b7a6a88f518a Uploaded
melpetera
parents:
diff changeset
15 -----------
b7a6a88f518a Uploaded
melpetera
parents:
diff changeset
16
1
bb19b1d15732 Uploaded
melpetera
parents: 0
diff changeset
17 This tool is provided as one of the [Workflow4Metabolomics](http://workflow4metabolomics.org) Galaxy instance utilities. W4M is a French infrastructure providing software tools to process, analyse and annotate metabolomics data.
0
b7a6a88f518a Uploaded
melpetera
parents:
diff changeset
18
b7a6a88f518a Uploaded
melpetera
parents:
diff changeset
19 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.
b7a6a88f518a Uploaded
melpetera
parents:
diff changeset
20
b7a6a88f518a Uploaded
melpetera
parents:
diff changeset
21
b7a6a88f518a Uploaded
melpetera
parents:
diff changeset
22 Configuration
b7a6a88f518a Uploaded
melpetera
parents:
diff changeset
23 -----------
b7a6a88f518a Uploaded
melpetera
parents:
diff changeset
24
b7a6a88f518a Uploaded
melpetera
parents:
diff changeset
25 ### Requirement:
b7a6a88f518a Uploaded
melpetera
parents:
diff changeset
26 * R software: version > 3.0.0 recommended
b7a6a88f518a Uploaded
melpetera
parents:
diff changeset
27 * Specific R library: 'batch'
b7a6a88f518a Uploaded
melpetera
parents:
diff changeset
28 * Submodule: [easyRlibrary](https://github.com/workflow4metabolomics/easyrlibrary-lib) (Required for internal input quality checks)
b7a6a88f518a Uploaded
melpetera
parents:
diff changeset
29
b7a6a88f518a Uploaded
melpetera
parents:
diff changeset
30 ### Deploy:
b7a6a88f518a Uploaded
melpetera
parents:
diff changeset
31 * How to get the submodule files:
b7a6a88f518a Uploaded
melpetera
parents:
diff changeset
32 When pulling this module's Git repository, you may only obtain an empty folder for the needed submodule.
b7a6a88f518a Uploaded
melpetera
parents:
diff changeset
33 You can initialise it then with the following command:
b7a6a88f518a Uploaded
melpetera
parents:
diff changeset
34 ```bash
b7a6a88f518a Uploaded
melpetera
parents:
diff changeset
35 git submodule update --init --recursive
b7a6a88f518a Uploaded
melpetera
parents:
diff changeset
36 ```
b7a6a88f518a Uploaded
melpetera
parents:
diff changeset
37
b7a6a88f518a Uploaded
melpetera
parents:
diff changeset
38
b7a6a88f518a Uploaded
melpetera
parents:
diff changeset
39 Technical description
b7a6a88f518a Uploaded
melpetera
parents:
diff changeset
40 -----------
b7a6a88f518a Uploaded
melpetera
parents:
diff changeset
41
b7a6a88f518a Uploaded
melpetera
parents:
diff changeset
42 Main files:
b7a6a88f518a Uploaded
melpetera
parents:
diff changeset
43
b7a6a88f518a Uploaded
melpetera
parents:
diff changeset
44 - IDchoice_script.R: R function (core script)
b7a6a88f518a Uploaded
melpetera
parents:
diff changeset
45 - IDchoice_wrap.R: R script to link the main R function to inputs
b7a6a88f518a Uploaded
melpetera
parents:
diff changeset
46 - IDchoice.xml: XML wrapper (interface for Galaxy)
b7a6a88f518a Uploaded
melpetera
parents:
diff changeset
47
b7a6a88f518a Uploaded
melpetera
parents:
diff changeset
48
b7a6a88f518a Uploaded
melpetera
parents:
diff changeset
49 Services provided
b7a6a88f518a Uploaded
melpetera
parents:
diff changeset
50 -----------
b7a6a88f518a Uploaded
melpetera
parents:
diff changeset
51
b7a6a88f518a Uploaded
melpetera
parents:
diff changeset
52 * Help and support: support@workflow4metabolomics.org
1
bb19b1d15732 Uploaded
melpetera
parents: 0
diff changeset
53
bb19b1d15732 Uploaded
melpetera
parents: 0
diff changeset
54
bb19b1d15732 Uploaded
melpetera
parents: 0
diff changeset
55 License
bb19b1d15732 Uploaded
melpetera
parents: 0
diff changeset
56 -----------
bb19b1d15732 Uploaded
melpetera
parents: 0
diff changeset
57
bb19b1d15732 Uploaded
melpetera
parents: 0
diff changeset
58 * Cea Cnrs Inria Logiciel Libre License, version 2.1 (CECILL-2.1)