annotate BC/README.md @ 3:2e3a23dd6c24 draft default tip

Uploaded
author melpetera
date Thu, 28 Feb 2019 05:12:34 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
1 Signal drift and batch-effect correction
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
2 ========================================
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
3
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
4 A Galaxy module from the [Workflow4metabolomics](http://workflow4metabolomics.org) infrastructure
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
5
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
6 Status: [![Build Status](https://travis-ci.org/workflow4metabolomics/batchcorrection.svg?branch=master)](https://travis-ci.org/workflow4metabolomics/batchcorrection).
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
7
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
8 ### Description
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
9
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
10 **Version:** 2.2.4
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
11 **Date:** 2019-01-22
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
12 **Author:** Jean-Francois Martin (INRA, AXIOM), Melanie Petera (INRA, PFEM), Marion Landi (INRA, PFEM), Franck Giacomoni (INRA, PFEM), and Etienne A. Thevenot (CEA, LIST)
2e3a23dd6c24 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)
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
14 **Citation:**
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
15 **Licence:** CeCILL
2e3a23dd6c24 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)
2e3a23dd6c24 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)
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
18
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
19 ### Installation
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
20
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
21 * Configuration files:
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
22 + `batch_correction.xml` (for the "Batch Correction" module)
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
23 + `determine_bc.xml` (for the "Determine Batch Correction" module)
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
24 * Image files:
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
25 + `static/images/batch_correction.png`
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
26 + `static/images/determine_batch_correction.png`
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
27 + `static/images/pdf_plotsituation.png`
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
28 + `static/images/Vdk_pdf1.png`
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
29 + `static/images/Vdk_pdf2.png`
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
30 * Wrapper files:
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
31 + `batch_correction_wrapper.R`
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
32 + `batch_correction_all_loess_wrapper.R`
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
33 * Script files:
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
34 + `Normalisation_QCpool.r`
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
35 + `batch_correction_all_loess_script.R`
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
36 * R packages
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
37 + **batch** from CRAN
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
38
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
39 ```r
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
40 install.packages("batch", dep=TRUE)
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
41 ```
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
42
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
43 + **ade4** from CRAN
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
44
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
45 ```r
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
46 install.packages("ade4", dep=TRUE)
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
47 ```
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
48
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
49 + **pcaMethods** from Bioconductor
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
50
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
51 ```r
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
52 source("http://www.bioconductor.org/biocLite.R")
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
53 biocLite("pcaMethods")
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
54 ```
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
55
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
56 + **ropls** from Bioconductor
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
57
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
58 ```r
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
59 source("http://www.bioconductor.org/biocLite.R")
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
60 biocLite("ropls")
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
61 ```
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
62
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
63 ### Tests
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
64
2e3a23dd6c24 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
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
66
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
67 You will need to install **RUnit** package in order to make it run:
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
68 ```r
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
69 install.packages('RUnit', dependencies = TRUE)
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
70 ```
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
71
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
72 ### Working example
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
73
2e3a23dd6c24 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)
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
75
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
76
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
77 ### News
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
78
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
79 ###### CHANGES IN VERSION 2.2.4
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
80
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
81 INTERNAL MODIFICATIONS
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
82
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
83 Fixed bug for pool selection ("all_loess" methods)
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
84
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
85 ###### CHANGES IN VERSION 2.2.2
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
86
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
87 INTERNAL MODIFICATIONS
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
88
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
89 Fixed bug for color plot ("all_loess" methods)
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
90
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
91 ###### CHANGES IN VERSION 2.2.0
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
92
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
93 NEW FEATURE
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
94
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
95 Specific names for the 'sampleType', 'injectionOrder', and 'batch' from sampleMetadata can be selected by the user (for compatibility with the MTBLS downloader)
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
96
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
97 ##### CHANGES IN VERSION 2.1.2
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
98
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
99 INTERNAL MODIFICATIONS
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
100
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
101 * Minor modifications in config file
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
102
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
103 ##### CHANGES IN VERSION 2.1.0
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
104
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
105 INTERNAL MODIFICATIONS
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
106
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
107 * For PCA figure display only ("all_loess_" options): missing values are set to the minimum value before PCA computation is performed (with svd)
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
108
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
109 * Additional running and installation tests added with planemo, conda, and travis
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
110
2e3a23dd6c24 Uploaded
melpetera
parents:
diff changeset
111 * 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)