Genome-wide extraction of reproducible continuous-valued signals hidden in noisy multisample functional genomics data
Project description
Consenrich
Consenrich is a sequential genome-wide state estimator for extraction of reproducible, spatially-resolved, epigenomic signals hidden in noisy multisample HTS data.
-
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 'treatment' sample (e.g., ChIP-seq)
- $m \geq 1$ Sequence alignment files
-
Output: Real-valued 'consensus' epigenomic state estimates (BedGraph/BigWig) and uncertainty metrics.
- Robust, spatially informative consensus signal track representing multiple samples' epigenomic profiles $\implies$ Consenrich-extracted signal tracks can present additional insight for a variety of conventional analyses aiming to construct encompassing regulatory characterizations of sample groups (e.g., consensus peak calling)
- Consenrich is robust to scaling differences and models each sample's data and respective noise $\implies$ extract consensus signal tracks across HTS samples from different, related assays (e.g., ATAC-seq + DNase-seq, ChIP-seq + CUT-N-RUN)
- Consenrich can extract spectral features common to sample groups and is conducive to a wider range of signal processing-based analyses , e.g., targeted detection of structural/spatial patterns associated with specific regulatory properties/states.
Several technical features of Consenrich are discussed below.
Example Command-Line Use
-
Run Consenrich on ten ATAC-seq samples in the current directory. Generate a BigWig signal track and inverse-variance-weighted residuals.
consenrich --bam_files *.bam -g hg38 -o hg38_test_output.tsv --signal_bigwig demo_signal.bw --residual_bigwig demo_ivw_residuals.bw
-
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
Download/Install
Consenrich can be easily downloaded and installed from source:
git clone https://github.com/nolan-h-hamilton/Consenrich.gitcd Consenrichpython setup.py sdist bdist_wheelpython -m pip install .- Check installation:
consenrich --help
Consenrich is also 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.
Technical Features
- Effectively models sample-and-region-varying noise to better integrate data across heterogeneous samples
- Balances biologically-informed a priori predictions with observed HTS data to determine final estimates
- Provides interpretable uncertainty quantification with respect to multiple model aspects
- Runs efficiently in linear time with respect to genome size.
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.0b0.tar.gz.
File metadata
- Download URL: consenrich-0.1.0b0.tar.gz
- Upload date:
- Size: 4.7 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d7cc6b1a8ae49bd0fae212f6d1db802635fcd6465193f636e65775f7f7c690f4
|
|
| MD5 |
b17ccf674a8e3f626e771ab18df7c210
|
|
| BLAKE2b-256 |
16669ecf827272beb6596d2ef96a3cf0f9e784cc942b16b0194e4b9e812f399c
|
File details
Details for the file consenrich-0.1.0b0-py3-none-any.whl.
File metadata
- Download URL: consenrich-0.1.0b0-py3-none-any.whl
- Upload date:
- Size: 4.3 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
574bf575158e486fc8fa350116edc5ae5f4643adbed270155af4de9d4f0a3f9a
|
|
| MD5 |
92665fcc88167ef51aeb1c5ced323896
|
|
| BLAKE2b-256 |
0d0d5aa3da4fafb7591c5515c0793c6a00f59ce1f97bb344cdff7fc303be1ca7
|