Genome-wide extraction of reproducible continuous-valued signals hidden in noisy multisample functional genomics data
Project description
Consenrich
Consenrich is a sequential state estimator for extraction of genome-wide epigenetic signals and uncertainty quantification inferred from multi-sample high-throughput functional genomics datasets.
Consenrich sequentially estimates epigenomic states from multisample HTS data--ATAC-seq, ChIP-seq, etc. By modeling both (i) local and global spatial dependencies and (ii) noise due to regional artifacts and individual samples, Consenrich yields a genome-wide track of 'consensus' signal estimates with variance propagation and elucidated spatial features.
Usage
-
Input:
- $m \geq 1$ Sequence alignment files
-t/--bam_filescorresponding 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_waveletdb<2,3,...>,sym<2,3,...>,haar,coif<1,2,...>,dmey)
- $m \geq 1$ Sequence alignment files
-
Output:
- Genome-wide 'consensus' epigenomic state estimates and uncertainty metrics
- (Optional): BED-like output(s) of localized enrichment patterns across multiple resolutions, obtained with a genomics-oriented matched filtering variant, e.g.,
ConsenrichMatchedResult(Het10, <template_name>)
Example: Consenrich-estimated signal tracks and uncertainty metrics given an input dataset consisting of $m=10$ ATAC-seq alignments of varying data quality (lymphoblastoid)
consenrich --bam_files ENCFF*.bam -g hg38 --match_wavelet haar,db2,db4
Download/Install
Consenrich is available via PyPI/pip:
python -m pip install consenrich
Consenrich can also be cloned and built from source:
git clone https://github.com/nolan-h-hamilton/Consenrich.gitcd Consenrichpython setup.py sdist bdist_wheelpython -m pip install .
Check installation: consenrich -h
Manuscript Preprint and Citation
A manuscript preprint is available on bioRxiv. A revised, up-to-date manuscript is forthcoming.
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file consenrich-0.1.13b1.tar.gz.
File metadata
- Download URL: consenrich-0.1.13b1.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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8616a75977baec3bd29598336d4d8b931902a3d63ee24e1c48f58e83b9cdeb3d
|
|
| MD5 |
a92e54ebe772aa8e1895000b7f4a2acd
|
|
| BLAKE2b-256 |
bb515463bf50c809261420771be8afd9dc856461742f107ed9576ae2c55be7ce
|
File details
Details for the file consenrich-0.1.13b1-py3-none-any.whl.
File metadata
- Download URL: consenrich-0.1.13b1-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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
82cb69d46172ea42f891e9845199651c7412a353f8d79ca3c569641737cb2d23
|
|
| MD5 |
6cb71aa0b4495e5c2aab2a9b21393a7a
|
|
| BLAKE2b-256 |
92e7eea4e578402fb00af023d6c85bfd90dde6c6f23e1ae15113a2ad262ff273
|