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

Uploaded Python 3

File details

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

File metadata

  • Download URL: smftools-0.3.2.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.2.tar.gz
Algorithm Hash digest
SHA256 fb02c3e0a08a82a0e824270f8f8949ac1800d560cdda065535a50b24f94a409d
MD5 4be3db0c3503b476872e8fbab595aa60
BLAKE2b-256 d74759056ff5612e26fc263a42c3665caf495e833d9edd812b89e794f6b71457

See more details on using hashes here.

File details

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

File metadata

  • Download URL: smftools-0.3.2-py3-none-any.whl
  • Upload date:
  • Size: 8.3 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 a5c724675fe0ced1c3a663b42b2e3bfba7afd2c1316dcde6bb42eb0d9bea8c78
MD5 fa255f4cafacdbc406548798f7e0325d
BLAKE2b-256 011001cfd22d34f21d6a7d6e1092e7b286412884cb233a4d355efc6d244198be

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