Skip to main content

A computational pipeline enabling functional annotation using amino acid recoding.

Project description

Snekmer: A scalable pipeline for protein sequence fingerprinting using amino acid recoding (AAR)

DOI CI Documentation Status Snakemake

Snekmer is a software package designed to reduce the representation of protein sequences by combining amino acid reduction (AAR) with the kmer approach. Based on the AAR-kmer representations, Snekmer subsequently (1) clusters sequences using various unsupervised clustering algorithms, (2) generates supervised machine learning models, or (3) searches sequences against pre-trained models to determine probabilistic annotations.

There are 5 operation modes for Snekmer: cluster, model, search, learn, and apply.

Cluster mode: The user supplies files containing sequences in an appropriate format (e.g. FASTA). Snekmer applies the relevant workflow steps and outputs the resulting clustering results in tabular form (.CSV), as well as the cluster object itself (.cluster). Figures are also generated (e.g. t-SNE, UMAP) to help the user contextualize their results.

Model mode: The user supplies files containing sequences in an appropriate format (e.g. FASTA). Snekmer applies the relevant workflow steps and outputs the resulting models as objects (.model). Snekmer also displays K-fold cross validation results in the form of figures (AUC ROC and PR AUC curves) and a table (.CSV).

Search mode: The user supplies files containing sequences in an appropriate format (e.g. FASTA) and the models they wish to search their sequences against. Snekmer applies the relevant workflow steps and outputs a table for each file containing model annotation probabilities for the given sequences.

Learn mode: The user supplies files containing sequences in an appropriate format (e.g. FASTA) as well as an annotation file. Snekmer generates a kmer counts matrix with the summed kmer distribution of each annotation recognized from the sequence ID. Snekmer then performs a self-evaluation to assess confidence levels. There are two outputs, a counts matrix, and a global confidence distribution.

Apply mode: The user supplies files containing sequences in an appropriate format (e.g. FASTA) and the outputs received from Learn. Snekmer uses cosine distance to predict the annotation of each sequence from the kmer counts matrix. The output is a table for each file containing sequence annotation predictions with confidence levels.

How to Use Snekmer

For installation instructions, documentation, and more, refer to the official documentation.

To run the demonstration example, see resources/tutorial/demo_example.

Snekmer was written and is maintained by the following PNNL development team: Christine Chang, Jeremy Jacobson, Abby Jerger, Bill Nelson, and Jason McDermott.

Citation Guidance

  1. McDermott, Jason E., Chang, Christine H., Jerger, Abby, Nelson, William B., & Jacobson, Jeremy R. (2023). Snekmer: A scalable pipeline for protein sequence fingerprinting using amino acid recoding (AAR) (v1.0.3). Zenodo. https://doi.org/10.5281/zenodo.7662597
  2. Christine H Chang, William C Nelson, Abby Jerger, Aaron T Wright, Robert G Egbert, Jason E McDermott, Snekmer: a scalable pipeline for protein sequence fingerprinting based on amino acid recoding, Bioinformatics Advances, Volume 3, Issue 1, 2023, vbad005, https://doi.org/10.1093/bioadv/vbad005.

License

This material was prepared as an account of work sponsored by an agency of the United States Government. Neither the United States Government nor the United States Department of Energy, nor Battelle, nor any of their employees, nor any jurisdiction or organization that has cooperated in the development of these materials, makes any warranty, express or implied, or assumes any legal liability or responsibility for the accuracy, completeness, or usefulness or any information, apparatus, product, software, or process disclosed, or represents that its use would not infringe privately owned rights.

Reference herein to any specific commercial product, process, or service by trade name, trademark, manufacturer, or otherwise does not necessarily constitute or imply its endorsement, recommendation, or favoring by the United States Government or any agency thereof, or Battelle Memorial Institute. The views and opinions of authors expressed herein do not necessarily state or reflect those of the United States Government or any agency thereof.

PACIFIC NORTHWEST NATIONAL LABORATORY operated by BATTELLE for the UNITED STATES DEPARTMENT OF ENERGY under Contract DE-AC05-76RL01830

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

snekmer-1.2.0.tar.gz (64.0 kB view details)

Uploaded Source

Built Distribution

snekmer-1.2.0-py3-none-any.whl (73.5 kB view details)

Uploaded Python 3

File details

Details for the file snekmer-1.2.0.tar.gz.

File metadata

  • Download URL: snekmer-1.2.0.tar.gz
  • Upload date:
  • Size: 64.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.10.8

File hashes

Hashes for snekmer-1.2.0.tar.gz
Algorithm Hash digest
SHA256 f84583c9c55dd19eb8ef3daa151f0b4188606519c3595cc16d2e10fed6f32848
MD5 37141530fe21081ba6044d9335d8ba4d
BLAKE2b-256 acb30bcacd0cf9aeb39a5a7ae609325c5c2d63bf4cdf9963d5e6843e7c388935

See more details on using hashes here.

File details

Details for the file snekmer-1.2.0-py3-none-any.whl.

File metadata

  • Download URL: snekmer-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 73.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.10.8

File hashes

Hashes for snekmer-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 41eecebf5c7e86c36b625644880edfc3b160ff8b76c72527e259ad2869b954a8
MD5 313092f75015bc6c05314fbb10181e99
BLAKE2b-256 ad683d8c8e00369158761151fc86f90c17ffaee500f79c14628a24e3e6a8079d

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page