Mercurial > repos > melpetera > generic_filter
diff GalFilter/README.md @ 3:cfd7c4aa5c26 draft default tip
Uploaded
author | melpetera |
---|---|
date | Fri, 03 Jan 2020 04:09:28 -0500 |
parents | |
children |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/GalFilter/README.md Fri Jan 03 04:09:28 2020 -0500 @@ -0,0 +1,53 @@ +Generic Filter +======= + +Metadata +----------- + + * **@name**: Generic Filter + * **@version**: 2020.01 + * **@authors**: Marion Landi and Melanie Petera for first version - Maintainer: Melanie Petera (PFEM ; INRAE ; MetaboHUB) + * **@init date**: 2014, december + * **@main usage**: This tool allows to remove all samples and/or variables corresponding to specific values regarding designated factors or numerical variables. + + +Context +----------- + +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. + +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. + + +Configuration +----------- + +### Requirement: + * R software: version > 3.0.0 recommended + * Specific R library: 'batch' + +### Docker: + * Use of this tool in a docker context: +Information is provided in the [about_docker.md file](about_docker.md). + + +Technical description +----------- + +Main files: + +- filter_script.R: R function (core script) +- filter_wrap.R: R script to link the main R function to inputs +- generic_filter.xml: XML wrapper (interface for Galaxy) + + +Services provided +----------- + + * Help and support: support@workflow4metabolomics.org + + +License +----------- + + * Cea Cnrs Inria Logiciel Libre License, version 2.1 (CECILL-2.1)