pyComBat, a Python tool for batch effects correction in high-throughput molecular data using empirical Bayes methods
Project description
pyComBat
pyComBat [1] is a Python 3 implementation of ComBat [2], one of the most widely used tool for correcting technical biases, called batch effects, in microarray expression data.
More detailed documentation can be found at this address.
TO DO
Minimum dependencies
We list here the versions of the packages that have been used for development/testing of pyComBat, as well as for writing the documentation.
pyComBat dependencies
-
python 3.6
-
numpy 1.16.4
-
mpmath 1.1.0
-
pandas 0.24.2
-
patsy 0.5.1
Documentation
- sphinx 2.1.2
Usage example
Installation
You can install pyComBat directly with:
pip install combat
You can upgrade pyComBat to its latest version with:
pip install combat --upgrade
Running pyComBat
The simplest way of using pyComBat is to first import it, and then simply use the pycombat function with default parameters:
from combat.pycombat import pycombat
data_corrected = pycombat(data,batch)
-
data: The expression matrix as a dataframe. It contains the information about the gene expression (rows) for each sample (columns).
-
batch: List of batch indexes. The batch list describes the batch for each sample. The list of batches contains as many elements as the number of columns in the expression matrix.
How to contribute
Please refer to CONTRIBUTING.md to learn more about the contribution guidelines.
References
[1] Behdenna A, Haziza J, Azencot CA and Nordor A. (2020) pyComBat, a Python tool for batch effects correction in high-throughput molecular data using empirical Bayes methods. bioRxiv doi: 10.1101/2020.03.17.995431
[2] Johnson W E, et al. (2007) Adjusting batch effects in microarray expression data using empirical Bayes methods. Biostatistics, 8, 118–127
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file combat-0.3.0.tar.gz
.
File metadata
- Download URL: combat-0.3.0.tar.gz
- Upload date:
- Size: 11.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.6.1 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.7.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9ae97d3a79c6e70bd2d75a67ad9b8f5f1343dd66175f45a88d7bf96e55bcd3e1 |
|
MD5 | c7a0e821aee6e675b35a44a93f31fa7b |
|
BLAKE2b-256 | c95c0a89976b659bd69251493c0230c254b1bcc214873b72be70b72a9ea09bab |
Provenance
File details
Details for the file combat-0.3.0-py3-none-any.whl
.
File metadata
- Download URL: combat-0.3.0-py3-none-any.whl
- Upload date:
- Size: 36.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.6.1 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.7.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4b7f7b9c4be41c0c03fff0c03108e2ec89825a2328263b74524fbecbf87fa29f |
|
MD5 | 2d0f9b95993051c3b11bf682bb1ccf58 |
|
BLAKE2b-256 | 3537e0d8fa2bc9d95374ecaccc5a3ab52f1b101e2c1868d22c199160d701b7d4 |