Skip to main content

Segmentation/resquiggling tool for ONT signals.

Project description

Dynamont

A Dynamic Programming Approach to Segment ONT Signals. Dynamont is a segmentation/resquiggling tool for ONT signals. Dynamont is currently designed for RNA002 and RNA004 data!

  • Currently, I applied the trained transition parameters from the RNA004 model to the DNA R10 models. These should be fine-tuned for the DNA models.

PyPI - Python Version License: GPL v3 PyPI PyPI - Downloads Anaconda-Server Badge Conda Conda package Conda package

DOI



Installation

Pypi/pip

pip install dynamont

Conda

conda config --add channels jannessp # to install all dependencies from the correct channel
conda create -n dynamont jannessp::dynamont
conda activate dynamont

Usage

# segment a dataset
dynamont-resquiggle -r <path/to/pod5/dataset/> -b <basecalls.bam> --mode basic --model_path <path/to/model> -o <output.csv> -p <pore>

# train model
dynamont-train -r <path/to/pod5/dataset/> -b <basecalls.bam> --mode basic --model_path <path/to/init/model> -o <output/path> -p <pore>

Output

Dynamont produces a tabular output with the following columns:

Column Name Description
readid Unique identifier for the read.
signalid Identifier for the signal corresponding to the read.
start Start position of the signal segment in the read.
end End position of the signal segment in the read.
basepos Reference base position in the genomic sequence.
base The detected base at this position.
motif The surrounding sequence motif in which the base appears.
state The methylation state (or modification state) of the base.
posterior_probability Probability assigned to the predicted segment.
polish Polished kmer, only available in resquiggle mode.

Example Output

Below is an example of the output generated by Dynamont:

readid,signalid,start,end,basepos,base,motif,state,posterior_probability,polish
476b4ed2-7865-4f81-9f78-82d614fb40a2,476b4ed2-7865-4f81-9f78-82d614fb40a2,12762,12777,53,A,AAAAAAAAA,M,0.12434,NA
476b4ed2-7865-4f81-9f78-82d614fb40a2,476b4ed2-7865-4f81-9f78-82d614fb40a2,12777,12791,52,A,AAAAAAAAA,M,0.12146,NA
476b4ed2-7865-4f81-9f78-82d614fb40a2,476b4ed2-7865-4f81-9f78-82d614fb40a2,12791,12806,51,A,AAAAAAAAA,M,0.11881,NA
476b4ed2-7865-4f81-9f78-82d614fb40a2,476b4ed2-7865-4f81-9f78-82d614fb40a2,12806,12820,50,A,AAAAAAAAA,M,0.11665,NA

Exit-Codes

  • -11: Segmentation fault
  • -9: Out of Memory error. Decrease the number of processes or move to a system with more memory.
  • -6: std::bad_alloc
  • 1: resquiggle mode specific: alignment score (Z) does not match between forward and backward run in preprocessing on signal (T) and read (N).
  • 2: resquiggle mode specific: alignment score (Z) does not match between forward and backward run in preprocessing on signal (T) and error correction (C).
  • 3: Alignment score (Z) does not match between forward and backward pass or is -Infinity
  • 4: Input signal is missing or not found in stdin stream
  • 5: Input read is missing or not found in stdin stream
  • 7: Invalid model path was provided
  • 8: Provided ONT signal is too short
  • 9: Read is too short
  • 10: Signal is smaller than read
  • 11: Read is smaller than kmerSize of provided pore model

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dynamont-0.6.4.tar.gz (287.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

dynamont-0.6.4-py3-none-any.whl (306.7 kB view details)

Uploaded Python 3

File details

Details for the file dynamont-0.6.4.tar.gz.

File metadata

  • Download URL: dynamont-0.6.4.tar.gz
  • Upload date:
  • Size: 287.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for dynamont-0.6.4.tar.gz
Algorithm Hash digest
SHA256 9962e8a674c605ddb2c28e27e30fbddbfc7c63e141f36ac2b801982cfb37ed7f
MD5 b280dbd868394a949040499493bf0f3c
BLAKE2b-256 8c585ff824310bbd3a9825248a805cfc306f9f4e5fa79fcdb810704423eb4d08

See more details on using hashes here.

File details

Details for the file dynamont-0.6.4-py3-none-any.whl.

File metadata

  • Download URL: dynamont-0.6.4-py3-none-any.whl
  • Upload date:
  • Size: 306.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for dynamont-0.6.4-py3-none-any.whl
Algorithm Hash digest
SHA256 6cafdc8aa2584214815bbe5e0df10a3ae9f2d8bc7ad316987af336a06febeab1
MD5 d57646934a3354d5cd6c1030959a832f
BLAKE2b-256 682d3b198d5f94947e4b094ac6ea7cf20e5aef64a9cf4ea498015e30035f7e83

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page