consenrich 0.7.4b2__cp312-cp312-macosx_10_13_x86_64.whl

consenrich/misc_util.py

@@ -0,0 +1,122 @@
+# -*- coding: utf-8 -*-
+r"""
+==============================================================================
+`consenrich.misc_util` -- Miscellaneous utility functions
+==============================================================================
+
+"""
+
+import os
+from typing import List, Optional, Tuple
+import logging
+import re
+import numpy as np
+import pandas as pd
+import pybedtools as bed
+import pysam as sam
+
+from scipy import signal, ndimage
+
+logging.basicConfig(
+    level=logging.INFO,
+    format="%(asctime)s - %(module)s.%(funcName)s -  %(levelname)s - %(message)s",
+)
+logging.basicConfig(
+    level=logging.WARNING,
+    format="%(asctime)s - %(module)s.%(funcName)s -  %(levelname)s - %(message)s",
+)
+logger = logging.getLogger(__name__)
+
+
+def checkBamFile(bamFile: str) -> bool:
+    r"""Check that the bam file exists and is indexed
+
+    Assumes the bam file is sorted by coordinates
+    """
+    has_index = False
+    if not os.path.exists(bamFile):
+        raise FileNotFoundError(f"Could not find {bamFile}")
+    try:
+        bamfile = sam.AlignmentFile(bamFile, "rb")
+        has_index = bamfile.check_index()
+        bamfile.close()
+    except AttributeError as aex:
+        logger.info(f"Alignments must be in BAM format:\n{aex}")
+        raise
+    except ValueError as vex:
+        has_index = False
+        pass
+
+    if not has_index:
+        try:
+            logger.info(
+                f"Could not find index file for {bamFile}. Calling pysam.index()"
+            )
+            sam.index(bamFile)
+            has_index = True
+        except Exception as ex:
+            logger.warning(
+                f"Encountered the following exception\n{ex}\nCould not create index file for {bamFile}: is it sorted?"
+            )
+
+    return has_index
+
+
+def bamsArePairedEnd(
+    bamFiles: List[str], maxReads: int = 1_000
+) -> List[bool]:
+    """
+    Take a list of BAM files, return a list (bool) indicating whether
+    each BAM contains paired-end reads (True) or only single-end reads (False).
+
+    :param bamFiles: List of paths to BAM files
+    :type bamFiles: List[str]
+    :param maxReads: Maximum number of reads to check in each BAM file
+    :type maxReads: int
+    :return: List of booleans corresponding to each BAM file
+    :rtype: List[bool]
+    """
+
+    results = []
+    for path in bamFiles:
+        paired = False
+        seen = 0
+        with sam.AlignmentFile(path, "rb") as bam:
+            for rec in bam.fetch(until_eof=True):
+                if rec.is_paired:
+                    paired = True
+                    break
+                seen += 1
+                if maxReads is not None and seen >= maxReads:
+                    break
+        results.append(paired)
+    return results
+
+
+def getChromSizesDict(
+    sizes_file: str,
+    excludeRegex: str = r"^chr[A-Za-z0-9]+$",
+    excludeChroms: Optional[List[str]] = None,
+) -> dict:
+    r"""The function getChromSizesDict is a helper to get chromosome sizes file as a dictionary.
+    :param sizes_file: Path to a genome assembly's chromosome sizes file
+    :param exclude_regex: Regular expression to exclude chromosomes. Default: all non-standard chromosomes.
+    :param exclude_chroms: List of chromosomes to exclude.
+    :return: Dictionary of chromosome sizes. Formatted as `{chromosome_name: size}`
+    """
+    if excludeChroms is None:
+        excludeChroms = []
+    return {
+        k: v
+        for k, v in pd.read_csv(
+            sizes_file,
+            sep="\t",
+            header=None,
+            index_col=0,
+            names=["chrom", "size"],
+        )["size"]
+        .to_dict()
+        .items()
+        if re.search(excludeRegex, k) is not None
+        and k not in excludeChroms
+    }

consenrich-0.7.4b2.dist-info/METADATA

@@ -0,0 +1,65 @@
+Metadata-Version: 2.4
+Name: consenrich
+Version: 0.7.4b2
+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 cohorts' epigenetic 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 binding, histone modification, etc.
+* Candidate prioritization for differential analyses, functional validation, integrative modeling, 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}
+}
+```

consenrich-0.7.4b2.dist-info/RECORD

@@ -0,0 +1,37 @@
+consenrich-0.7.4b2.dist-info/RECORD,,
+consenrich-0.7.4b2.dist-info/WHEEL,sha256=mer8vOuI-KlBtJIdzgyZALHdls6RZGRaE6RPt7dfKrk,138
+consenrich-0.7.4b2.dist-info/entry_points.txt,sha256=EXIGcSTyc16vtPkfHJNs-aaSVoq6Pn5Ev5GeW1JCYn0,58
+consenrich-0.7.4b2.dist-info/top_level.txt,sha256=jsWw8GC11dOKPcdULXk-ggW357CO-vTNW6ssryqa21Q,11
+consenrich-0.7.4b2.dist-info/METADATA,sha256=yNgRmON1PjuxjF_201a5T30Wd3j6Bxfwt-p_GYck_7c,2559
+consenrich-0.7.4b2.dist-info/licenses/LICENSE,sha256=w09-aT0LFrH_cL3ShJWz-xusRpbThwTpdmBD08tc8EI,1074
+consenrich/detrorm.py,sha256=Wm3M0LH5R0UWJpKlQqxrv2xDlWMDP_DyYwEdnUI2itI,8946
+consenrich/misc_util.py,sha256=GteSAUuWUVLV1DYWoOOikLfGI3J3gW7JKZrCBet3f6I,3689
+consenrich/constants.py,sha256=yDehsQVmkNXeji0PUbYzJHjILPJgXIkOdznoBHWsNyo,5091
+consenrich/__init__.py,sha256=UEAddImbk7lAPy3WyuI6kaOuSWDGPxQ8goF3l0na2NU,320
+consenrich/core.py,sha256=CuXwBYCg1aXkfRC41vduSi7Q6d8VyTDV4WI8rITQ4C8,57436
+consenrich/cconsenrich.cpython-312-darwin.so,sha256=d7P9Z_3GOaWTS0xqihzJU10l7P0IYf6N5ioJXXpPnJo,366120
+consenrich/matching.py,sha256=RLF9q3HP1j6tvrg4FKCp-K1kGcoyTWn5L0S-SWMIu4A,31775
+consenrich/consenrich.py,sha256=lqQt1_gGV-RsyTtHSzKI0BmAndZI8Yu0pw3Ihj55GO8,46540
+consenrich/cconsenrich.pyx,sha256=6HOWSGdWhb79tCm1ErulHWtczT7lw-WzbXDQJTtjcvg,33490
+consenrich/cconsenrich.c,sha256=v-K0n5rSX0pDqOiQhjrUt_fidOvc4bHQA_4D2l71FtE,2071670
+consenrich/data/hg19.sizes,sha256=ewnSktA_Ps1BoiU3yeLNaJxJO-taq3uKE4-6JUnly1o,365
+consenrich/data/mm10.sizes,sha256=sgHMQGBr6yEm4hKqeN3auQJdlMX4ZdqDQ23EdDmWedU,320
+consenrich/data/hg38_blacklist.bed,sha256=zbamE4bP5JJT-ivyDp61LjvaI00Wo-vd0oKtFxy_u4E,14940
+consenrich/data/ce10_sparse.bed,sha256=0jIOO1CW5itA9HsERvJ8E9Ta-bLtFipYXg76OQBPYIY,263712
+consenrich/data/ce10_blacklist.bed,sha256=JIAbS0PbeVmtIy7MiZRZyEGK4yvA0ek0q2sjxaOAXyY,2215
+consenrich/data/dm6_blacklist.bed,sha256=WARyyesi9b86fFXbbEi5JvBBatnYNgtavkIcxH9Z9Ww,4120
+consenrich/data/mm39_blacklist.bed,sha256=xbWP9aa9LZFZGTFzSU4JGnTaLlpt3A3_OTLZUZ672zI,79975
+consenrich/data/hg38.sizes,sha256=IfUNvzVusS77dscRz5LlHykgiffc6ckyMPp77Z1fpOE,365
+consenrich/data/mm10_blacklist.bed,sha256=RiC_83MGGXSgvZo3vhCsJR5ixCr8WbONRSN-jOqel-4,81653
+consenrich/data/mm39_sparse.bed,sha256=am6wiZvVaKtOYuyHacooDodCHKsiA1e3Bta5zNdYNA8,2409256
+consenrich/data/ce11_sparse.bed,sha256=a-XyExCkosFoOmTnwdVnU9817BKRtT7d2AZqhCCmlMs,263712
+consenrich/data/ce11.sizes,sha256=94La5R1EjWf6QauJiUKCMS5N7y_XKmvnU01BKbSBTZs,88
+consenrich/data/hg19_blacklist.bed,sha256=3oF2nmPFuSxZ5LWE9mPvMCQzgy-kBoFTVdMd7z8al00,19821
+consenrich/data/hg38_sparse.bed,sha256=hqQTeSJVlzWEZqq_DPJgKS9NIHhpa8Tur0UYqClcXQw,6902926
+consenrich/data/mm39.sizes,sha256=LpkYY8S_gNuuXyrUG0S0DmDVF1Bkh0Fg_PzMH7otdGE,320
+consenrich/data/hg19_sparse.bed,sha256=kNq94yialQCLNp-tbPqIdFYq3A_7L8Coxo0w3cl1bH0,6897180
+consenrich/data/ce11_blacklist.bed,sha256=3etEe4n3o61N1HSx7pS9vYtEUWELq1VT_DOTDjLoQc0,2153
+consenrich/data/mm10_sparse.bed,sha256=ukvVuheKf4gxzAzXUbKZ1sewsmP-WOsUz60ySENkmuw,2409812
+consenrich/data/ce10.sizes,sha256=1crlJDro3lhUpECU_2g9eVIUFM27mw0uMzWqtdmThgA,88
+consenrich/data/dm6.sizes,sha256=0MNGeHSdAwu-Ym_ApUlHoDybDZDNyqYhbVbR_srZiEY,100
+consenrich/data/dm6_sparse.bed,sha256=H9wvrZs2ACdtUbDZhLXEEJ4xL5OpKOxhU_Pqf2EyDOM,445849

consenrich-0.7.4b2.dist-info/WHEEL

@@ -0,0 +1,6 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: false
+Tag: cp312-cp312-macosx_10_13_x86_64
+Generator: delocate 0.13.0
+

consenrich-0.7.4b2.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+consenrich = consenrich.consenrich:main

consenrich-0.7.4b2.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Nolan H. Hamilton
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

consenrich-0.7.4b2.dist-info/top_level.txt

@@ -0,0 +1 @@
+consenrich