FiberHMM
Chromatin footprint calling on single DNA molecules from Fiber-seq (m6A) and
DAF-seq (deamination) data. For every read, FiberHMM calls nucleosomes,
transcription-factor and other sub-nucleosomal footprints, and the
methylase-sensitive patches (MSPs) between them, using sequence-context-aware
emission models; across molecules, it finds recurrent footprint classes and
measures how often each molecule carries them. Calls are written into the BAM
as fibertools-compatible ns/nl/as/al and Molecular-annotation MA/AQ
tags, readable by ft, FIRE and FiberBrowser.
Documentation: fiberseq.github.io/FiberHMM
(source in docs/).
FiberHMM 3.0 is the third generation of the FiberHMM family, released with FiberBrowser 3.0.0. The emission tables have been updated, so re-run calls made with earlier versions.
fiberhmm-check <your outputs>lists which files need re-running. See Upgrading from 2.x and the CHANGELOG.
What's new in 3.0
- DddA nucleosomes follow the helical phase. DddA (SsDddA, scDAF-seq)
also deaminates inside nucleosomes, in step with the ~10-bp helical phase
of the wrapped DNA.
fiberhmm-call --enzyme dddanow places nucleosomes with a phase-aware rotational model, so internal deaminations no longer break nucleosomes into pieces. - scDAF duplexes.
fiberhmm-pairfinds the two strands (CT and GA reads) of one DddA molecule and calls footprints on both strands jointly. The DddA TF emission table is recalibrated in chromatin on physical scDAF duplexes. - CpG-island methylation from deamination.
fiberhmm-tag-m5ccalls each molecule's CpG islands as methylated or unmethylated, andfiberhmm-call-m5ccalls methylated and unmethylated domains across molecules. For DddA, CpGs are masked by default outside confidently unmethylated islands, in the first-pass HMM and in footprint recall (--use-m5c,--cpg-mask-policy). - Cleaner DAF input. Adjacent CC/GG targets are thinned to one (keep-one, on for DddA), strand-swap chimeras are filtered, and PCR duplicates are marked by deamination pattern.
fiberhmm-pipelinegoes from reads and a reference (FASTA or plasmid map) to a called BAM ready for FiberBrowser in one command.fiberhmm-checkreads your existing outputs and lists which ones need re-running, with the command to use.- Updated emission tables. The Nanopore Hia5 table is rebuilt from matched controls and DddB has a new in-vivo table.
- Footprint classes.
fiberhmm-consensusfinds recurrent footprint classes across molecules and measures them per molecule, andfiberhmm-transfermeasures frozen classes in new data. - Python 3.10 to 3.14.
Install
pip install fiberhmm # Python 3.10 to 3.14
pip install "fiberhmm[all]" # plus QC figures (matplotlib) and HDF5 posteriors (h5py)
Quick start
# DAF-seq amplicons / plasmids: reads + reference in, FiberBrowser-ready calls out
fiberhmm-pipeline reads.fastq.gz --reference plasmid.dna --enzyme dddb -o run/
# Aligned BAMs
fiberhmm-call -i aligned.bam -o calls.bam --enzyme hia5 --seq pacbio -c 8 --region-parallel # Hia5 PacBio
fiberhmm-call -i aligned.bam -o calls.bam --enzyme hia5 --seq nanopore -c 8 --region-parallel # Hia5 Nanopore
fiberhmm-call -i aligned.bam -o calls.bam --enzyme dddb -c 8 --region-parallel # DddB DAF-seq (DddA: --enzyme ddda)
fiberhmm-extract -i calls.bam -o tracks/ # BED12 / bigBed tracks
A synthetic demo data set and a walk-through of every chemistry are in the Quick start.
Documentation
- Getting started:
installation, quick start, choosing
--enzymeand--seq - Concepts: how FiberHMM works, chemistries and platforms, coordinate frames, tags and scores
- Workflows:
calling, re-calling, DAF-seq, plasmids, duplex pairing, tracks, posteriors,
QC, footprint classes (
fiberhmm-consensus), transfer, strand rescue, training - Reference:
every command and option, BAM tags, header declarations, footprint-tag
frames, checking outputs for re-runs (
fiberhmm-check), bundled models, consensus output files, Python API, environment variables - Troubleshooting
License
MIT; see LICENSE. Citing FiberHMM.
Metadata
Release files for fiberhmm 3.0.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| fiberhmm-3.0.2.tar.gz | 5.8 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| fiberhmm-3.0.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 9.0 MB
Release files / fiberhmm-3.0.2.tar.gz
| Download URL | fiberhmm-3.0.2.tar.gz |
|---|---|
| Size | 5.8 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
072850077aeff6cf1bb21d7f5c760a506c8f19277d814a8675b5e8b52d9ea6c1
|
|
BLAKE2b-256 checksum How to use checksums |
6e855b53bd8bb3e79061e5de804bf722cd75c1afff368be71583c7c7a65a6002
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.10.13
|
Release files / fiberhmm-3.0.2-py3-none-any.whl
| Download URL | fiberhmm-3.0.2-py3-none-any.whl |
|---|---|
| Size | 3.2 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
05d7b58affb4f4f7950879e6a5412afda8ef23384da7899cc88dbe6a2c1948a9
|
|
BLAKE2b-256 checksum How to use checksums |
8ab01adb24d9b3cdcbb006aae04b9a2a690ecbba9d426a1cf6fd460423fa7820
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.10.13
|