Skip to main content

Single Molecule Footprinting Analysis in Python.

Project description

PyPI Docs

smftools

A Python tool for processing raw sequencing data derived from single molecule footprinting experiments into anndata objects. Additional functionality for preprocessing, spatial analyses, and HMM based feature annotation.

Philosophy

While genomic data structures (SAM/BAM) were built to handle low-coverage data (<1000X) along large references, smftools prioritizes high-coverage data (scalable to >1,000,000X coverage) of a few genomic loci at a time. This enables efficient data storage, rapid data operations, hierarchical metadata handling, seamless integration with various machine-learning packages, and ease of visualization. Furthermore, functionality is modularized, enabling analysis sessions to be saved, reloaded, and easily shared with collaborators. Analyses are centered around the anndata object, and are heavily inspired by the work conducted within the single-cell genomics community.

Dependencies

The following CLI tools need to be installed and configured before using the informatics (smftools.inform) module of smftools, which is used by the smftools load CLI command:

  1. Dorado -> Basecalling, alignment, demultiplexing. Required for Nanopore SMF experiments, but not Illumina SMF experiments.
  2. Minimap2 -> Aligner if not using dorado. Support for other aligners could eventually be added if needed.
  3. Modkit -> Extracting read level methylation metrics from the MM/ML tags in BAM files. Only required for direct modification detection SMF protocols.

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

smftools-0.3.0.tar.gz (9.3 MB view details)

Uploaded Source

Built Distribution

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

smftools-0.3.0-py3-none-any.whl (8.2 MB view details)

Uploaded Python 3

File details

Details for the file smftools-0.3.0.tar.gz.

File metadata

  • Download URL: smftools-0.3.0.tar.gz
  • Upload date:
  • Size: 9.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for smftools-0.3.0.tar.gz
Algorithm Hash digest
SHA256 2d7f27ddd6d0b07e1787d0e7dbadb972e387a8ef562e919518fee45a81b3cafb
MD5 d64fffe42dd5cfdca15646f3326ad51b
BLAKE2b-256 31071d8d070ca3479416468b5dec16e69e2e55a2fe7eb17a4461266da5b0b568

See more details on using hashes here.

File details

Details for the file smftools-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: smftools-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 8.2 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for smftools-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a42f95020b3fdb43253bd3f2086ab602e6678d79894ff135f1fe1969dba11f67
MD5 e76f08fa2851c2c9b6d7251e9890a5dd
BLAKE2b-256 eee8b14f8019720f2afdeb58b73c39d2640f7e6b48591c1f7bc86bfd1709f0dd

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