Skip to main content

This package serves as a toolkit and repository for the White-Kauffmann-Le Minor scheme for Salmonella serotyping, which defines nomenclature and antigenic factors for each recognized serovar. The scheme is made available in multiple formats, along with methods for querying, comparing, and predicting serovar names and antigenic formulae.

Project description

https://img.shields.io/pypi/v/serotools.svg

This package serves as a toolkit and repository for the White-Kauffmann-Le Minor scheme for Salmonella serotyping, which defines nomenclature and antigenic factors for each recognized serovar. The scheme is made available in multiple formats, along with methods for querying and comparing serovar names and antigenic formulae, as well as determining the most abundant serovar for a cluster of isolates.

SeroTools was developed by the United States Food and Drug Administration, Center for Food Safety and Applied Nutrition.

Features

  • Query the White-Kauffmann-Le Minor Salmonella serotyping repository

  • Compare serovar predictions for state of congruence

  • Determine the most abundant serovar for a cluster of isolates

Citing SeroTools

To cite SeroTools, please reference the SeroTools GitHub repository:

https://github.com/CFSAN-Biostatistics/serotools

License

See the LICENSE file included in the SeroTools distribution.

History

0.2.0 (2020-02-17)

Significant updates in this version - not backwards compatible.

  • The underlying data structures have been converted to pandas Series and DataFrames.

  • New ‘cluster’ subcommand functionality provides the most abundant serovar(s) for clusters of isolates.

  • The ‘predict’ subcommand functionality has been merged into the ‘query’ subcommand, such that the default query will return any exact, congruent, and minimally congruent matches unless only exact matches are desired.

  • The WKLM repository is now available as a pandas DataFrame, in addition to dictionaries and lists.

0.1.1 (2019-11-27)

  • Corrected a variable name in cli.py

  • Updated the algorithm for minimally congruent serovars

0.1.0 (2019-11-19)

  • Initial version.

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

serotools-0.2.0.tar.gz (139.7 kB view hashes)

Uploaded Source

Built Distribution

serotools-0.2.0-py2.py3-none-any.whl (123.1 kB view hashes)

Uploaded Python 2 Python 3

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