annotate batchcorrection-57edfd3943ab/README.md @ 3:73892ef177e3 draft

Uploaded
author melpetera
date Tue, 02 May 2017 09:47:22 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
1 Signal drift and batch-effect correction
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
2 ========================================
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
3
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
4 A Galaxy module from the [Workflow4metabolomics](http://workflow4metabolomics.org) infrastructure
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
5
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
6 Status: [![Build Status](https://travis-ci.org/workflow4metabolomics/batchcorrection.svg?branch=master)](https://travis-ci.org/workflow4metabolomics/batchcorrection).
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
7
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
8 ### Description
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
9
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
10 **Version:** 2.1.2
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
11 **Date:** 2017-04-30
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
12 **Author:** Jean-François Martin (INRA, AXIOM), Mélanie Pétéra (INRA, PFEM), Marion Landi (INRA, PFEM), Franck Giacomoni (INRA, PFEM), and Etienne A. Thévenot (CEA, LIST)
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
13 **Email:** [jean-francois.martin(at)toulouse.inra.fr](mailto:jean-francois.martin@toulouse.inra.frr), [melanie.petera(at)clermont.inra.fr](mailto:melanie.petera@clermont.inra.fr), [etienne.thevenot(at)cea.fr](mailto:etienne.thevenot@cea.fr)
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
14 **Citation:**
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
15 **Licence:** CeCILL
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
16 **Reference history:** [W4M00001_Sacurine-statistics; DOI:10.15454/1.4811121736910142E12](http://dx.doi.org/10.15454/1.4811121736910142E12) and [W4M00002_Sacurine-comprehensive; DOI:10.15454/1.481114233733302E12](http://dx.doi.org/10.15454/1.481114233733302E12)
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
17 **Funding:** Agence Nationale de la Recherche ([MetaboHUB](http://www.metabohub.fr/index.php?lang=en&Itemid=473) national infrastructure for metabolomics and fluxomics, ANR-11-INBS-0010 grant)
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
18
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
19 ### Installation
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
20
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
21 * Configuration files:
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
22 + `batch_correction.xml` (for the "Batch Correction" module)
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
23 + `determine_bc.xml` (for the "Determine Batch Correction" module)
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
24 * Image files:
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
25 + `static/images/batch_correction.png`
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
26 + `static/images/determine_batch_correction.png`
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
27 + `static/images/pdf_plotsituation.png`
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
28 + `static/images/Vdk_pdf1.png`
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
29 + `static/images/Vdk_pdf2.png`
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
30 * Wrapper files:
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
31 + `batch_correction_wrapper.R`
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
32 + `batch_correction_all_loess_wrapper.R`
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
33 * Script files:
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
34 + `Normalisation_QCpool.r`
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
35 + `batch_correction_all_loess_script.R`
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
36 * R packages
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
37 + **batch** from CRAN
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
38
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
39 ```r
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
40 install.packages("batch", dep=TRUE)
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
41 ```
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
42
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
43 + **ade4** from CRAN
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
44
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
45 ```r
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
46 install.packages("ade4", dep=TRUE)
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
47 ```
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
48
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
49 + **pcaMethods** from Bioconductor
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
50
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
51 ```r
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
52 source("http://www.bioconductor.org/biocLite.R")
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
53 biocLite("pcaMethods")
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
54 ```
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
55
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
56 + **ropls** from Bioconductor
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
57
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
58 ```r
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
59 source("http://www.bioconductor.org/biocLite.R")
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
60 biocLite("ropls")
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
61 ```
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
62
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
63 ### Tests
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
64
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
65 The code in the batch_correction_wrapper can be tested by running the `runit/batchcorrection_runtests.R` R file
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
66
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
67 You will need to install **RUnit** package in order to make it run:
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
68 ```r
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
69 install.packages('RUnit', dependencies = TRUE)
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
70 ```
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
71
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
72 ### Working example
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
73
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
74 See the reference histories [W4M00001_Sacurine-statistics; DOI:10.15454/1.4811121736910142E12](http://dx.doi.org/10.15454/1.4811121736910142E12) and [W4M00002_Sacurine-comprehensive; DOI:10.15454/1.481114233733302E12](http://dx.doi.org/10.15454/1.481114233733302E12)
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
75
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
76
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
77 ### News
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
78
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
79 ##### CHANGES IN VERSION 2.1.2
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
80
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
81 INTERNAL MODIFICATIONS
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
82
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
83 * Minor modifications in config file
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
84
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
85 ##### CHANGES IN VERSION 2.1.0
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
86
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
87 INTERNAL MODIFICATIONS
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
88
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
89 * For PCA figure display only ("all_loess_" options): missing values are set to the minimum value before PCA computation is performed (with svd)
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
90
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
91 * Additional running and installation tests added with planemo, conda, and travis
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
92
73892ef177e3 Uploaded
melpetera
parents:
diff changeset
93 * Modification of the 'all_loess_wrapper.R' file to handle 'ropls' package versions of 1.3.15 and above (i.e. after switching to S4 classes)