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

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