Skip to main content

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.18.5

  • 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

combat-0.3.2.tar.gz (34.2 kB view details)

Uploaded Source

Built Distribution

combat-0.3.2-py3-none-any.whl (36.8 kB view details)

Uploaded Python 3

File details

Details for the file combat-0.3.2.tar.gz.

File metadata

  • Download URL: combat-0.3.2.tar.gz
  • Upload date:
  • Size: 34.2 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

Hashes for combat-0.3.2.tar.gz
Algorithm Hash digest
SHA256 32cc48f40ef8260af8be05a168c2695120f3afa6b95ebff1346697480325bb92
MD5 c7ba390154d47e79113e90e8d7fa7e17
BLAKE2b-256 46e64e2213898a9f273fc0c6e0eb931b701feb10f32d4bc28b7b786fc564c76a

See more details on using hashes here.

Provenance

File details

Details for the file combat-0.3.2-py3-none-any.whl.

File metadata

  • Download URL: combat-0.3.2-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

Hashes for combat-0.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 088f430a7ba5a172c11b6b8cba5f8f0036213cb016c6d2cb1adae7f7d031fbe1
MD5 c317452b8a3c1c65df7c0f07f9da9887
BLAKE2b-256 b9fec4eda68d25fd6c2eb33f09df776203d7d00c4b9987a932ecad8b84fae41b

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page