annotate GalFilter/README.md @ 3:cfd7c4aa5c26 draft default tip

Uploaded
author melpetera
date Fri, 03 Jan 2020 04:09:28 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
cfd7c4aa5c26 Uploaded
melpetera
parents:
diff changeset
1 Generic Filter
cfd7c4aa5c26 Uploaded
melpetera
parents:
diff changeset
2 =======
cfd7c4aa5c26 Uploaded
melpetera
parents:
diff changeset
3
cfd7c4aa5c26 Uploaded
melpetera
parents:
diff changeset
4 Metadata
cfd7c4aa5c26 Uploaded
melpetera
parents:
diff changeset
5 -----------
cfd7c4aa5c26 Uploaded
melpetera
parents:
diff changeset
6
cfd7c4aa5c26 Uploaded
melpetera
parents:
diff changeset
7 * **@name**: Generic Filter
cfd7c4aa5c26 Uploaded
melpetera
parents:
diff changeset
8 * **@version**: 2020.01
cfd7c4aa5c26 Uploaded
melpetera
parents:
diff changeset
9 * **@authors**: Marion Landi and Melanie Petera for first version - Maintainer: Melanie Petera (PFEM ; INRAE ; MetaboHUB)
cfd7c4aa5c26 Uploaded
melpetera
parents:
diff changeset
10 * **@init date**: 2014, december
cfd7c4aa5c26 Uploaded
melpetera
parents:
diff changeset
11 * **@main usage**: This tool allows to remove all samples and/or variables corresponding to specific values regarding designated factors or numerical variables.
cfd7c4aa5c26 Uploaded
melpetera
parents:
diff changeset
12
cfd7c4aa5c26 Uploaded
melpetera
parents:
diff changeset
13
cfd7c4aa5c26 Uploaded
melpetera
parents:
diff changeset
14 Context
cfd7c4aa5c26 Uploaded
melpetera
parents:
diff changeset
15 -----------
cfd7c4aa5c26 Uploaded
melpetera
parents:
diff changeset
16
cfd7c4aa5c26 Uploaded
melpetera
parents:
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.
cfd7c4aa5c26 Uploaded
melpetera
parents:
diff changeset
18
cfd7c4aa5c26 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.
cfd7c4aa5c26 Uploaded
melpetera
parents:
diff changeset
20
cfd7c4aa5c26 Uploaded
melpetera
parents:
diff changeset
21
cfd7c4aa5c26 Uploaded
melpetera
parents:
diff changeset
22 Configuration
cfd7c4aa5c26 Uploaded
melpetera
parents:
diff changeset
23 -----------
cfd7c4aa5c26 Uploaded
melpetera
parents:
diff changeset
24
cfd7c4aa5c26 Uploaded
melpetera
parents:
diff changeset
25 ### Requirement:
cfd7c4aa5c26 Uploaded
melpetera
parents:
diff changeset
26 * R software: version > 3.0.0 recommended
cfd7c4aa5c26 Uploaded
melpetera
parents:
diff changeset
27 * Specific R library: 'batch'
cfd7c4aa5c26 Uploaded
melpetera
parents:
diff changeset
28
cfd7c4aa5c26 Uploaded
melpetera
parents:
diff changeset
29 ### Docker:
cfd7c4aa5c26 Uploaded
melpetera
parents:
diff changeset
30 * Use of this tool in a docker context:
cfd7c4aa5c26 Uploaded
melpetera
parents:
diff changeset
31 Information is provided in the [about_docker.md file](about_docker.md).
cfd7c4aa5c26 Uploaded
melpetera
parents:
diff changeset
32
cfd7c4aa5c26 Uploaded
melpetera
parents:
diff changeset
33
cfd7c4aa5c26 Uploaded
melpetera
parents:
diff changeset
34 Technical description
cfd7c4aa5c26 Uploaded
melpetera
parents:
diff changeset
35 -----------
cfd7c4aa5c26 Uploaded
melpetera
parents:
diff changeset
36
cfd7c4aa5c26 Uploaded
melpetera
parents:
diff changeset
37 Main files:
cfd7c4aa5c26 Uploaded
melpetera
parents:
diff changeset
38
cfd7c4aa5c26 Uploaded
melpetera
parents:
diff changeset
39 - filter_script.R: R function (core script)
cfd7c4aa5c26 Uploaded
melpetera
parents:
diff changeset
40 - filter_wrap.R: R script to link the main R function to inputs
cfd7c4aa5c26 Uploaded
melpetera
parents:
diff changeset
41 - generic_filter.xml: XML wrapper (interface for Galaxy)
cfd7c4aa5c26 Uploaded
melpetera
parents:
diff changeset
42
cfd7c4aa5c26 Uploaded
melpetera
parents:
diff changeset
43
cfd7c4aa5c26 Uploaded
melpetera
parents:
diff changeset
44 Services provided
cfd7c4aa5c26 Uploaded
melpetera
parents:
diff changeset
45 -----------
cfd7c4aa5c26 Uploaded
melpetera
parents:
diff changeset
46
cfd7c4aa5c26 Uploaded
melpetera
parents:
diff changeset
47 * Help and support: support@workflow4metabolomics.org
cfd7c4aa5c26 Uploaded
melpetera
parents:
diff changeset
48
cfd7c4aa5c26 Uploaded
melpetera
parents:
diff changeset
49
cfd7c4aa5c26 Uploaded
melpetera
parents:
diff changeset
50 License
cfd7c4aa5c26 Uploaded
melpetera
parents:
diff changeset
51 -----------
cfd7c4aa5c26 Uploaded
melpetera
parents:
diff changeset
52
cfd7c4aa5c26 Uploaded
melpetera
parents:
diff changeset
53 * Cea Cnrs Inria Logiciel Libre License, version 2.1 (CECILL-2.1)