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 epigenomic signals and pattern localization in noisy multisample HTS data.


  • 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)
    • (Optional): wavelet-based template(s) to match for genome-wide pattern matching (--match_wavelet db<2,3,...>, sym<2,3,...>, haar, coif<1,2,...>, dmey)
  • Output:

    • Genome-wide 'consensus' epigenomic state estimates and uncertainty metrics (BedGraph/BigWig)
    • (Optional) BED-like output of relative maxima in the response sequence (convolution) with wavelet-based template(s)

Example output with --match_wavelet haar,db4
Example: Consenrich outputs given 10 input ATAC-seq samples (lymphoblastoid) consenrich --bam_files ENCFF*.bam -g hg38 --match_wavelet haar,db4


Download/Install

Consenrich is available via PyPI/pip:

  • 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

A corresponding manuscript preprint is available on bioRxiv.

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.13b0.tar.gz (9.4 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.13b0-py3-none-any.whl (9.4 MB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for consenrich-0.1.13b0.tar.gz
Algorithm Hash digest
SHA256 0d783476be6767a8627a76af229f98f18d7924d3aad22e9fe37a0b835b689bd9
MD5 dc4bf451c9bb034cbd088aa2a93be431
BLAKE2b-256 b929cb5226e65436ebe04e77e4368085a8344749ed9ea20cc667a0c116e719be

See more details on using hashes here.

File details

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

File metadata

  • Download URL: consenrich-0.1.13b0-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.9

File hashes

Hashes for consenrich-0.1.13b0-py3-none-any.whl
Algorithm Hash digest
SHA256 9e87164d761bb49a5aeb9fd1f564bd32bd41d00a2f835f6edaa1a7810f4bda1a
MD5 5c7173570860130f4fa47a34d12b4c22
BLAKE2b-256 b9a496a3641b3269cc2e11adf72cf74dd9e9b799839df1920d5993e49d86b744

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