Skip to main content

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 ddda now places nucleosomes with a phase-aware rotational model, so internal deaminations no longer break nucleosomes into pieces.
  • scDAF duplexes. fiberhmm-pair finds 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-m5c calls each molecule's CpG islands as methylated or unmethylated, and fiberhmm-call-m5c calls 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-pipeline goes from reads and a reference (FASTA or plasmid map) to a called BAM ready for FiberBrowser in one command.
  • fiberhmm-check reads 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-consensus finds recurrent footprint classes across molecules and measures them per molecule, and fiberhmm-transfer measures 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 --enzyme and --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.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for fiberhmm 3.0.1
File Size Uploaded
fiberhmm-3.0.1.tar.gz 5.8 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for fiberhmm 3.0.1
File Interpreter ABI Platform
fiberhmm-3.0.1-py3-none-any.whl Python 3 none any Details

Total release size: 9.0 MB

Release files / fiberhmm-3.0.1.tar.gz

Download URL fiberhmm-3.0.1.tar.gz
Size 5.8 MB
Tags Source
SHA-256 checksum
How to use checksums
f0c54d25d6293a458dd676bd0592adc6bfe1f843850f2e33485a955f98978bef
BLAKE2b-256 checksum
How to use checksums
6c409c99f58fb5292172df1a02f90e005007f8b430d015e676c869796557a2b2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.10.13

Release files / fiberhmm-3.0.1-py3-none-any.whl

Download URL fiberhmm-3.0.1-py3-none-any.whl
Size 3.2 MB
Tags Python 3
SHA-256 checksum
How to use checksums
d3cf777b4774450abc8a09c007ef437509ca26e111a9ae3895cbaeeb283ac2a0
BLAKE2b-256 checksum
How to use checksums
e0a72e06e28b366135dc8e48745e85e9df89df7afcfc109656ed9a7d14b8f80c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.10.13

Release history Release notifications | RSS feed

3.0.2

2 release files

This release

3.0.1 This release

2 release files

3.0.0

2 release files

2.16.8

2 release files

2.16.6

2 release files

2.16.5

2 release files

2.16.3

2 release files

2.16.2

2 release files

2.16.1

2 release files

2.16.0

2 release files

2.15.0

2 release files

2.14.0

2 release files

2.13.4

2 release files

2.13.3

2 release files

2.13.2

2 release files

2.13.1

2 release files

2.13.0

2 release files

2.12.0

2 release files

2.10.5

1 release file

2.10.4

1 release file

2.10.3

1 release file

2.10.2

1 release file

2.10.1

1 release file

2.10.0

1 release file

2.9.7

1 release file

2.9.0

2 release files

2.8.2

2 release files

2.8.1

2 release files

2.8.0

2 release files

2.7.1

2 release files

2.7.0

2 release files

2.6.9

2 release files

2.6.8

2 release files

2.6.7

2 release files

2.6.6

2 release files

2.6.5

2 release files

2.6.4

1 release file

2.6.3

1 release file

2.6.2

1 release file

2.6.1

2 release files

2.6.0

2 release files

2.5.0

2 release files

2.4.0

2 release files

2.2.0

2 release files

2.1.0

2 release files

2.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page