combat

pyComBat is a Python 3 implementation of ComBat, one of the most widely used tool for correcting technical biases, called batch effects, in microarray expression data.

https://github.com/epigenelabs/pycombat

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
  • DOI references
    Found 1 DOI reference(s) in README
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (12.8%) to scientific vocabulary
Last synced: 10 months ago · JSON representation

Repository

pyComBat is a Python 3 implementation of ComBat, one of the most widely used tool for correcting technical biases, called batch effects, in microarray expression data.

Basic Info
  • Host: GitHub
  • Owner: epigenelabs
  • License: gpl-3.0
  • Language: Python
  • Default Branch: master
  • Size: 29.2 MB
Statistics
  • Stars: 87
  • Watchers: 5
  • Forks: 24
  • Open Issues: 10
  • Releases: 0
Archived
Created over 6 years ago · Last pushed over 2 years ago
Metadata Files
Readme Changelog Contributing License

README.md

MIGRATION WARNING

pyComBat has been merged into InMoose, and is no longer maintained as a standalone package. This repository remains up for reference, but will no longer be updated.

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:

python pip install combat

You can upgrade pyComBat to its latest version with:

python 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:

python 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

Owner

  • Name: Epigene Labs
  • Login: epigenelabs
  • Kind: organization
  • Location: Paris

GitHub Events

Total
  • Watch event: 9
  • Fork event: 2
Last Year
  • Watch event: 9
  • Fork event: 2

Committers

Last synced: over 2 years ago

All Time
  • Total Commits: 74
  • Total Committers: 9
  • Avg Commits per committer: 8.222
  • Development Distribution Score (DDS): 0.351
Past Year
  • Commits: 4
  • Committers: 1
  • Avg Commits per committer: 4.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Abdelkader Behdenna a****r@e****m 48
Aryo Gema 5****e 6
abdelkaderbehdenna 5****a 4
Maximilien Colange m****n@e****m 4
Guillaume Appé g****e@e****m 3
Guillaume Appé g****e@m****e 3
sergiigladchuk S****k 3
aryo a****o@e****m 2
Gian Arauz g****z@g****m 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 11 months ago

All Time
  • Total issues: 17
  • Total pull requests: 21
  • Average time to close issues: 4 months
  • Average time to close pull requests: 10 days
  • Total issue authors: 16
  • Total pull request authors: 9
  • Average comments per issue: 1.82
  • Average comments per pull request: 0.1
  • Merged pull requests: 16
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • such3r (2)
  • coldfire79 (1)
  • sama2689 (1)
  • gokceneraslan (1)
  • aliechoes (1)
  • tadahayamiz (1)
  • JBinkowski (1)
  • PARODBE (1)
  • haizi-zh (1)
  • julienrichardalbert (1)
  • aryoepigene (1)
  • fredsamhaak (1)
  • julienhaziza (1)
  • hhageBA (1)
  • soleneweill (1)
Pull Request Authors
  • aryoepigene (6)
  • EpigeneMax (4)
  • guillaumeap (3)
  • abdelkaderbehdenna (3)
  • EstrellaXD (2)
  • antoinegaston (1)
  • sergiigladchuk (1)
  • coldfire79 (1)
  • GianArauz (1)
Top Labels
Issue Labels
enhancement (3) bug (3) documentation (1)
Pull Request Labels
enhancement (2) bug (1)

Packages

  • Total packages: 2
  • Total downloads:
    • pypi 1,636 last-month
  • Total docker downloads: 31
  • Total dependent packages: 4
    (may contain duplicates)
  • Total dependent repositories: 7
    (may contain duplicates)
  • Total versions: 8
  • Total maintainers: 1
pypi.org: combat

pyComBat, a Python tool for batch effects correction in high-throughput molecular data using empirical Bayes methods

  • Versions: 7
  • Dependent Packages: 4
  • Dependent Repositories: 6
  • Downloads: 1,629 Last month
  • Docker Downloads: 31
Rankings
Dependent packages count: 2.3%
Docker downloads count: 3.9%
Average: 5.8%
Downloads: 6.0%
Dependent repos count: 6.0%
Forks count: 8.2%
Stargazers count: 8.3%
Maintainers (1)
Last synced: 11 months ago
pypi.org: pycombat-test

pyComBat, a Python tool for batch effects correction in high-throughput molecular data using empirical Bayes methods

  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 7 Last month
Rankings
Forks count: 8.2%
Stargazers count: 8.3%
Dependent packages count: 10.0%
Average: 20.8%
Dependent repos count: 21.7%
Downloads: 55.8%
Maintainers (1)
Last synced: 11 months ago

Dependencies

setup.py pypi
  • mpmath >=1.1.0
  • numpy >=1.18.5,<=1.19.5
  • pandas >=0.24.2,<=1.1.5
  • patsy ==0.5.1