Metadata-Version: 2.4
Name: consenrich
Version: 0.5.0b0
Summary: Genome-wide estimation of signals hidden in noisy multi-sample HTS datasets
Author-email: "Nolan H. Hamilton" <nolan.hamilton@unc.edu>
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: cython>=3.0
Requires-Dist: numpy>=2.1
Requires-Dist: scipy>=1.15
Requires-Dist: pandas>=2.3.0
Requires-Dist: pysam>=0.23.3
Requires-Dist: pybedtools>=0.11.2
Requires-Dist: PyYAML>=6.0.2
Requires-Dist: PyWavelets>=1.9.0
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: mypy; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Requires-Dist: build; extra == "dev"
Requires-Dist: twine; extra == "dev"
Provides-Extra: docs
Requires-Dist: sphinx>=7.3; extra == "docs"
Requires-Dist: sphinx-press-theme; extra == "docs"
Requires-Dist: furo; extra == "docs"
Requires-Dist: myst-parser>=2.0; extra == "docs"
Requires-Dist: sphinx-autodoc-typehints>=2.1; extra == "docs"
Requires-Dist: sphinx-autobuild>=2025.2; extra == "docs"
Requires-Dist: sphinx-copybutton>=0.5.0; extra == "docs"
Requires-Dist: sphinxcontrib-bibtex>=2.4.0; extra == "docs"
Dynamic: license-file
Dynamic: requires-python

# Consenrich

Consenrich is an adaptive linear state estimator that yields genome-wide, uncertainty-calibrated signal tracks from noisy multi-sample HTS data.

<p align="center">
  <img src="docs/images/noise.png" alt="Simplified Schematic of Consenrich." width="600">
</p>


Special emphasis is placed on computational efficiency, model interpretability, and practical utility for downstream tasks that require well-resolved genome-wide signal estimates and uncertainty quantification across samples, such as:

* Consensus detection of open chromatin regions, TF footprints, nucleosome occupancy, histone modification
* Candidate selection and boundary refinement for differential analyses, fine-mapping, reporter assays, etc.

[**See the Documentation**](https://nolan-h-hamilton.github.io/Consenrich/) for usage examples, installation details, configuration options, and an API reference.


## Manuscript Preprint and Citation

**BibTeX Citation**

```bibtex
@article {Hamilton2025,
	author = {Hamilton, Nolan H and Huang, Yu-Chen E 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},
	publisher = {Cold Spring Harbor Laboratory},
	journal = {bioRxiv}
}
```
