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

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