Skip to main content

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

Metadata

Release files for combat 0.3.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for combat 0.3.3
File Size Uploaded Provenance Actions
combat-0.3.3.tar.gz 34.7 kB Without provenance Details for combat-0.3.3.tar.gz

Release files / combat-0.3.3.tar.gz

Download URL combat-0.3.3.tar.gz
Size 34.7 kB
Tags Source
SHA-256 checksum
How to use checksums
25ed428f5c22d56545588c7ff2098982087bddd67b79a3220c3039d855b01271
BLAKE2b-256 checksum
How to use checksums
24fc02b94724719fe2ee6557133c5b3eb2b3a6c2b0a193dc09f808bfc4c8a246
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.10.6

Security for combat 0.3.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page