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.2.5.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.2.5-py3-none-any.whl (8.1 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: smftools-0.2.5.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.2.5.tar.gz
Algorithm Hash digest
SHA256 10210e75bf67f04a84bd7bfa9b02d84bb50fc799d2219b78119926f270b37772
MD5 ff2afc04e491349db11440959342956e
BLAKE2b-256 314d111a2373a766731d5336f39eda6b2e8713bd8bf6b5efff5c0cbe65ffe7a2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: smftools-0.2.5-py3-none-any.whl
  • Upload date:
  • Size: 8.1 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.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 f511925c06fa3dc416246684ff5d5480df3fd8e4b97feda2037070c8e523e191
MD5 ec9aab980f20527105d9beaa654c5201
BLAKE2b-256 8a1b5b1e58c86ee7fc13272be2cf01a2183f6285a62b9d1b064b50d7887c50f9

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