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.1.tar.gz (9.4 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.1-py3-none-any.whl (8.2 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: smftools-0.3.1.tar.gz
  • Upload date:
  • Size: 9.4 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.1.tar.gz
Algorithm Hash digest
SHA256 491fa7451a96f929133592e4abd70787931553235fe03dc54c97f42eff953e38
MD5 57f22af89c4bafccc16f47fb129237f8
BLAKE2b-256 a6bbb53bae95dc138acfd655d76fb32cd9cf9fb894ce059b7bd0895efc57f7c8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: smftools-0.3.1-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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6a290d8c23e1555dcc7c9958eff71b835781f2a52dd883bf457946b53a11676a
MD5 d755004cd996e240955642edcf00a4af
BLAKE2b-256 55dcc22bed496bb1ccdd56657fd6a619c1f096aef9e097073a50beed2e58991f

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