Skip to main content

Python package to perform enrichment analysis from omics data.

Project description

decoupler - Ensemble of methods to infer enrichment scores

Tests Documentation

Issues Coverage Stars

PyPI Downloads month Downloads all

Conda version Conda downloads

decoupler is a python package containing different enrichment statistical methods to extract biologically driven scores from omics data within a unified framework. This is its faster and memory efficient Python implementation, a deprecated version in R can be found here.

decoupler is part of the scverse® project (website, governance) and is fiscally sponsored by NumFOCUS. If you like scverse® and want to support our mission, please consider making a tax-deductible donation to help the project pay for developer time, professional services, travel, workshops, and a variety of other needs.

Getting started

Please refer to the documentation, in particular, the API documentation.

Installation

You need to have Python 3.11 or newer installed on your system. If you don't have Python installed, we recommend installing uv.

There are several alternative options to install decoupler:

  1. Install the latest stable release from PyPI with minimal dependancies:
pip install decoupler
  1. Install the latest stable full release from PyPI with extra dependancies:
pip install decoupler[full]
  1. Install the latest stable version from conda-forge using mamba or conda (pay attention to the -py suffix at the end):
mamba create -n=dcp conda-forge::decoupler-py
  1. Install the latest development version:
pip install git+https://github.com/scverse/decoupler.git@main

Claude Code Skill

decoupler ships an Agent Skill for Claude Code that teaches the agent to use the library correctly. Install it once into your personal skills directory:

decoupler-install-skills

This copies the skill to ~/.claude/skills/decoupler/, making it available in every project (re-run with --force after upgrading). Once installed, just ask Claude Code to do decoupler tasks ("find the most active TFs in this cell cluster", "score hallmark gene sets with ora", "build a consensus across methods") and the skill is consulted automatically. To avoid copying into your home directory, point Claude Code at the bundled copy instead:

export CLAUDE_SKILLS_PATH="$(decoupler-install-skills --print-path)"

Release notes

See the changelog.

Contact

For questions and help requests, you can reach out in the scverse discourse. If you found a bug, please use the issue tracker.

Citation

Badia-i-Mompel P., Vélez Santiago J., Braunger J., Geiss C., Dimitrov D., Müller-Dott S., Taus P., Dugourd A., Holland C.H., Ramirez Flores R.O. and Saez-Rodriguez J. 2022. decoupleR: Ensemble of computational methods to infer biological activities from omics data. Bioinformatics Advances. https://doi.org/10.1093/bioadv/vbac016

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

decoupler-2.2.0.tar.gz (1.2 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

decoupler-2.2.0-py3-none-any.whl (147.4 kB view details)

Uploaded Python 3

File details

Details for the file decoupler-2.2.0.tar.gz.

File metadata

  • Download URL: decoupler-2.2.0.tar.gz
  • Upload date:
  • Size: 1.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for decoupler-2.2.0.tar.gz
Algorithm Hash digest
SHA256 7e73ee9619b2006e4ab1c33cc465a952598f17c45dd74c6fd5056562c9e03233
MD5 2e26f7a94a0f627df4af7d945166e12a
BLAKE2b-256 30e97c65275561ab6801e5c45bc07ab26f52134cf6f7cd5cc510831fe5c9483d

See more details on using hashes here.

Provenance

The following attestation bundles were made for decoupler-2.2.0.tar.gz:

Publisher: release.yaml on scverse/decoupler

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file decoupler-2.2.0-py3-none-any.whl.

File metadata

  • Download URL: decoupler-2.2.0-py3-none-any.whl
  • Upload date:
  • Size: 147.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for decoupler-2.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b44557e15438ef7af08011bd37101330cf0123c67e53d18ed738c53a832df137
MD5 c24bced37752d8ee724a7532ab5f9583
BLAKE2b-256 292883df019db913031ce826e3ed3fa655df9663d58cc1f083d1adc78a1bb528

See more details on using hashes here.

Provenance

The following attestation bundles were made for decoupler-2.2.0-py3-none-any.whl:

Publisher: release.yaml on scverse/decoupler

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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