[](https://pypi.org/project/smftools)
[](https://smftools.readthedocs.io/en/latest/?badge=latest)
# smftools
A Python tool for processing raw sequencing data derived from single molecule footprinting experiments into [anndata](https://anndata.readthedocs.io/en/latest/) objects. Additional functionality for preprocessing, analysis, and visualization. Data structures are compatible with analyses developed within the [scverse](https://github.com/scverse) project, including [scanpy](https://github.com/scverse/scanpy) and [scvi-tools](https://github.com/scverse/scvi-tools).
## Philosophy
While most genomic data structures handle low-coverage data (<100X) along large references, smftools prioritizes high-coverage data (scalable to at least 1 million X 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](https://anndata.readthedocs.io/en/latest/) 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:
1) [Dorado](https://github.com/nanoporetech/dorado) -> For standard/modified basecalling and alignment. Can be attained by downloading and configuring nanopore MinKnow software.
2) [Samtools](https://github.com/samtools/samtools) -> For working with SAM/BAM files
3) [Minimap2](https://github.com/lh3/minimap2) -> The aligner used by Dorado
4) [Modkit](https://github.com/nanoporetech/modkit) -> Extracting summary statistics and read level methylation calls from modified BAM files
## Modules
- Informatics: Processes raw SMF data coming from Nanopore POD5 files, BAM files, or FASTQ files and organizes it into an AnnData object.
- Preprocessing: Filters the AnnData object on read length, total methylation, and a variety of QC metrics.
- Tools: Appends various analyses to the AnnData object.
- Plotting: Visualization of analyses stored within the AnnData object.
## Announcements
### 09/09/24 - The pre-alpha phase package ([smftools-0.1.1](https://pypi.org/project/smftools/))
The informatics module has been bumped to alpha-phase status. This module can deal with POD5s and unaligned BAMS from nanopore conversion and direct SMF experiments, as well as FASTQs from Illumina conversion SMF experiments. Primary output from this module is an AnnData object containing all relevant SMF data, which is compatible with all downstream smftools modules. The other modules are still in pre-alpha phase. Preprocessing, Tools, and Plotting modules should be promoted to alpha-phase within the next month or so.
### 08/30/24 - The pre-alpha phase package ([smftools-0.1.0](https://pypi.org/project/smftools/)) is installable through pypi!
Currently, this package (smftools-0.1.0) is going through rapid improvement (dependency handling accross Linux and Mac OS, testing, documentation, debugging) and is still too early in development for standard use. The underlying functionality was originally developed as a collection of scripts for single molecule footprinting (SMF) experiments in our lab, but is being packaged/developed to facilitate the expansion of SMF to any lab that is interested in performing these styles of experiments/analyses. The alpha-phase package is expected to be available within a couple months, so stay tuned!
Raw data
{
"_id": null,
"home_page": null,
"name": "smftools",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "Joseph McKenna <jkmckenna@berkeley.edu>",
"keywords": "anndata, chromatin-accessibility, machine-learning, nanopore, protein-dna-binding, single-locus, single-molecule-footprinting",
"author": "Joseph McKenna",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/ac/39/343ba5106b6d5b9a008a93e64d1e0c8430652984be140b43149599e49b94/smftools-0.1.1.tar.gz",
"platform": null,
"description": "[](https://pypi.org/project/smftools)\n[](https://smftools.readthedocs.io/en/latest/?badge=latest)\n\n# smftools\nA Python tool for processing raw sequencing data derived from single molecule footprinting experiments into [anndata](https://anndata.readthedocs.io/en/latest/) objects. Additional functionality for preprocessing, analysis, and visualization. Data structures are compatible with analyses developed within the [scverse](https://github.com/scverse) project, including [scanpy](https://github.com/scverse/scanpy) and [scvi-tools](https://github.com/scverse/scvi-tools).\n\n## Philosophy\nWhile most genomic data structures handle low-coverage data (<100X) along large references, smftools prioritizes high-coverage data (scalable to at least 1 million X 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](https://anndata.readthedocs.io/en/latest/) object, and are heavily inspired by the work conducted within the single-cell genomics community.\n\n## Dependencies\nThe following CLI tools need to be installed and configured before using the informatics (smftools.inform) module of smftools:\n1) [Dorado](https://github.com/nanoporetech/dorado) -> For standard/modified basecalling and alignment. Can be attained by downloading and configuring nanopore MinKnow software.\n2) [Samtools](https://github.com/samtools/samtools) -> For working with SAM/BAM files\n3) [Minimap2](https://github.com/lh3/minimap2) -> The aligner used by Dorado\n4) [Modkit](https://github.com/nanoporetech/modkit) -> Extracting summary statistics and read level methylation calls from modified BAM files\n\n## Modules\n- Informatics: Processes raw SMF data coming from Nanopore POD5 files, BAM files, or FASTQ files and organizes it into an AnnData object.\n- Preprocessing: Filters the AnnData object on read length, total methylation, and a variety of QC metrics.\n- Tools: Appends various analyses to the AnnData object.\n- Plotting: Visualization of analyses stored within the AnnData object.\n\n## Announcements\n### 09/09/24 - The pre-alpha phase package ([smftools-0.1.1](https://pypi.org/project/smftools/))\nThe informatics module has been bumped to alpha-phase status. This module can deal with POD5s and unaligned BAMS from nanopore conversion and direct SMF experiments, as well as FASTQs from Illumina conversion SMF experiments. Primary output from this module is an AnnData object containing all relevant SMF data, which is compatible with all downstream smftools modules. The other modules are still in pre-alpha phase. Preprocessing, Tools, and Plotting modules should be promoted to alpha-phase within the next month or so.\n\n### 08/30/24 - The pre-alpha phase package ([smftools-0.1.0](https://pypi.org/project/smftools/)) is installable through pypi!\nCurrently, this package (smftools-0.1.0) is going through rapid improvement (dependency handling accross Linux and Mac OS, testing, documentation, debugging) and is still too early in development for standard use. The underlying functionality was originally developed as a collection of scripts for single molecule footprinting (SMF) experiments in our lab, but is being packaged/developed to facilitate the expansion of SMF to any lab that is interested in performing these styles of experiments/analyses. The alpha-phase package is expected to be available within a couple months, so stay tuned!\n",
"bugtrack_url": null,
"license": null,
"summary": "Single Molecule Footprinting Analysis in Python.",
"version": "0.1.1",
"project_urls": {
"Source": "https://github.com/jkmckenna/smftools"
},
"split_keywords": [
"anndata",
" chromatin-accessibility",
" machine-learning",
" nanopore",
" protein-dna-binding",
" single-locus",
" single-molecule-footprinting"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "7f9ff4c536d16227b6d3c38d796beb5c0e8272b2295526367d8fe917f437f110",
"md5": "c6da7232cc97d0cf4255515554c5ac2c",
"sha256": "51ce2069ef3b81cd57fae62161f42ab3f7e8ad4dd449be9bcbce8b09323acfb9"
},
"downloads": -1,
"filename": "smftools-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c6da7232cc97d0cf4255515554c5ac2c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 7815339,
"upload_time": "2024-09-09T19:04:50",
"upload_time_iso_8601": "2024-09-09T19:04:50.684796Z",
"url": "https://files.pythonhosted.org/packages/7f/9f/f4c536d16227b6d3c38d796beb5c0e8272b2295526367d8fe917f437f110/smftools-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "ac39343ba5106b6d5b9a008a93e64d1e0c8430652984be140b43149599e49b94",
"md5": "b1fd0c91c915524607ceb76dd3dacf8c",
"sha256": "24262765e247aa721c20b081258c5bc37b8e9b0933fedb5d3e984cdc4c56783f"
},
"downloads": -1,
"filename": "smftools-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "b1fd0c91c915524607ceb76dd3dacf8c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 7829987,
"upload_time": "2024-09-09T19:04:52",
"upload_time_iso_8601": "2024-09-09T19:04:52.744057Z",
"url": "https://files.pythonhosted.org/packages/ac/39/343ba5106b6d5b9a008a93e64d1e0c8430652984be140b43149599e49b94/smftools-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-09 19:04:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jkmckenna",
"github_project": "smftools",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "smftools"
}
JSON
