Skip to main content

Genome-wide extraction of reproducible continuous-valued signals hidden in noisy multisample functional genomics data

Project description

Consenrich

Tests PyPI - Version

Consenrich is a sequential genome-wide state estimator for extraction of reproducible, spatially-resolved, epigenomic signals hidden in noisy multisample HTS data. The corresponding manuscript preprint is available on $$\text{bio}\textcolor{#960018}{R}\chi \text{iv}$$.


  • Input:

    • $m \geq 1$ Sequence alignment files -t/--bam_files corresponding to each sample in a given HTS experiment
    • (Optional): $m_c = m$ control sample alignments, -c/--control_files, for each 'control' sample (e.g., ChIP-seq)
  • Output:

    • Genome-wide 'consensus' epigenomic state estimates and uncertainty metrics (BedGraph/BigWig)

Features

  • Uncertainty-moderated signal tracks encompassing multiple samples' epigenomic profiles $\implies$ Insightful data representation for conventional analyses aiming to profile trait-specific regulatory landscapes (e.g., via consensus peak calling)

  • Models trends and noise profiles for each sample with scale-invariance $\implies$ Multi-sample, multi-assay estimation of target molecular states from related functional genomics assays, e.g., ChIP-seq + CUT-N-RUN, ATAC-seq + DNase-seq.

  • Preservation of spectral content $\implies$ Comparison and profiling of group-specific structural signatures discarded by traditional enrichment-focused measures for HTS data.

Example Use

  • Run Consenrich on ten heterogeneous ATAC-seq sample alignments in the current directory (*.bam).

    consenrich --bam_files *.bam -g hg38 --signal_bigwig demo_signal.bw --residuals_bigwig demo_residuals.bw
    

fig1


  • Use Consenrich for ChIP-seq enrichment analysis with treatment/control sample alignments (POL2RA, six donors' colon tissue samples). Generate separate BigWig output tracks for signal estimates and inverse-variance weighted residuals. Use fixed-width genomic intervals of 25bp:

    consenrich \
     --bam_files \
       ENCSR322JEO_POL2RA.bam \
       ENCSR472VBD_POL2RA.bam \
       ENCSR431EHE_POL2RA.bam \
       ENCSR724FCJ_POL2RA.bam \
       ENCSR974HQI_POL2RA.bam \
       ENCSR132XRW_POL2RA.bam \
     --control_files \
       ENCSR322JEO_CTRL.bam \
       ENCSR472VBD_CTRL.bam \
       ENCSR431EHE_CTRL.bam \
       ENCSR724FCJ_CTRL.bam \
       ENCSR974HQI_CTRL.bam \
       ENCSR132XRW_CTRL.bam \
     -g hg38 --step 25 \
     -o Consenrich_POL2RA.tsv \
     --signal_bigwig Consenrich_POL2RA_CTRL_Signal.bw \
     --residual_bigwig Consenrich_POL2RA_CTRL_IVW_Residuals.bw
    

Output ChIPDemo

Download/Install

Consenrich is available via PyPI/pip:

  • pip install consenrich

If managing multiple Python environments, use python -m pip install consenrich. If lacking administrative privileges, running with flag --user may be necessary.


Consenrich can also be easily downloaded and installed from source:

  1. git clone https://github.com/nolan-h-hamilton/Consenrich.git
  2. cd Consenrich
  3. python setup.py sdist bdist_wheel
  4. python -m pip install .
  5. Check installation: consenrich --help

Manuscript Preprint and Citation

Genome-Wide Uncertainty-Moderated Extraction of Signal Annotations from Multi-Sample Functional Genomics Data
Nolan H Hamilton, Benjamin D McMichael, Michael I Love, Terrence S Furey; doi: 10.1101/2025.02.05.636702


BibTeX

@article {Hamilton2025
	author = {Hamilton, Nolan H and McMichael, Benjamin D and Love, Michael I and Furey, Terrence S},
	title = {Genome-Wide Uncertainty-Moderated Extraction of Signal Annotations from Multi-Sample Functional Genomics Data},
	year = {2025},
	doi = {10.1101/2025.02.05.636702},
	url = {https://www.biorxiv.org/content/10.1101/2025.02.05.636702v1},
}

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

consenrich-0.1.1b0.tar.gz (9.8 MB view details)

Uploaded Source

Built Distribution

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

consenrich-0.1.1b0-py3-none-any.whl (9.4 MB view details)

Uploaded Python 3

File details

Details for the file consenrich-0.1.1b0.tar.gz.

File metadata

  • Download URL: consenrich-0.1.1b0.tar.gz
  • Upload date:
  • Size: 9.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.0

File hashes

Hashes for consenrich-0.1.1b0.tar.gz
Algorithm Hash digest
SHA256 4956928eeb23c7c5a6fe93428c69aa3654e790eaefc85ee252c0595921d4d952
MD5 37fd26e79235059c2e723d3002d89aed
BLAKE2b-256 b60d288936c7faaeb136f045e98cb5c0f8fd39b85c94e4b1d27ef2de16d71eb4

See more details on using hashes here.

File details

Details for the file consenrich-0.1.1b0-py3-none-any.whl.

File metadata

  • Download URL: consenrich-0.1.1b0-py3-none-any.whl
  • Upload date:
  • Size: 9.4 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.0

File hashes

Hashes for consenrich-0.1.1b0-py3-none-any.whl
Algorithm Hash digest
SHA256 52edd09554be526eca47cfedcd982e319ce84683ee80dab2aa4ea69eb8a5f167
MD5 4bef8e379e41ab33c90cc54d9317d719
BLAKE2b-256 29cd53a73765546526e7d9c64d85a40ec3786123926753c1ca8c02244c1aeced

See more details on using hashes here.

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