SeroTools
This package serves as a toolkit and repository for the White-Kauffmann-Le Minor scheme for Salmonella serotyping, which 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.
Free software
Documentation: https://serotools.readthedocs.io
Source Code: https://github.com/CFSAN-Biostatistics/serotools
PyPI Distribution: https://pypi.python.org/pypi/serotools
Introduction
Salmonella bacteria are major foodborne pathogens estimated by the U.S. Centers for Disease Control and Prevention to cause 1.35 million infections annually in the United States [1]. Serological subtyping (serotyping) of Salmonella has historically been a critical component of characterization and successful outbreak identification and traceback efforts employed by public health researchers and regulatory agencies. The White-Kauffmann-Le Minor (WKL) Salmonella serotyping scheme specifies the commonly accepted naming and formatting conventions for Salmonella serotyping data and the antigenic factors (and other characteristics) which define each serovar. Salmonella serotyping data is routinely employed by a broad range of scientific researchers, physicians, public health professionals, food safety experts, etc.
SeroTools addresses multiple critical needs for the efficient analysis of Salmonella serotyping data. As technological advances continue to produce a range of high resolution subtyping options, including in silico serovar prediction based on whole genome sequencing, new tools are necessary for efficient method-comparison studies and quality control applied to increasingly large numbers of isolates. SeroTools serves as the only multiformat WKL repository accessible for software development and provides the only existing tools for querying the WKL scheme, comparing serovars for congruence, and predicting the most abundant serovar for clusters of isolates.
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:
License
See the LICENSE file included in the SeroTools distribution.
History
0.2.1 (2020-09-04)
Updated documentation
Added JOSS manuscript
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 WKL 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.
Metadata
Release files for serotools 0.2.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| serotools-0.2.1.tar.gz | 142.8 kB | Without provenance | Details for serotools-0.2.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| serotools-0.2.1-py2.py3-none-any.whl | Python 3, Python 2 | none | any | Details for serotools-0.2.1-py2.py3-none-any.whl |
Total release size: 266.6 kB
Release files / serotools-0.2.1.tar.gz
| Download URL | serotools-0.2.1.tar.gz |
|---|---|
| Size | 142.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
67c535c8e6c4de02ecee69256d041b1c9f41e3cc724e048a383dd67546c434f9
|
|
BLAKE2b-256 checksum How to use checksums |
0edc2d2184463603b1101735c2118336e67ad2994e9eb961f7b522a5771546d1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.2.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/50.2.0 requests-toolbelt/0.9.1 tqdm/4.38.0 CPython/3.7.3
|
Release files / serotools-0.2.1-py2.py3-none-any.whl
| Download URL | serotools-0.2.1-py2.py3-none-any.whl |
|---|---|
| Size | 123.8 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
5f3e377868ce7bca97c069af6c76e33100533914aab1a93e7e5ce6b762409f9f
|
|
BLAKE2b-256 checksum How to use checksums |
561c2351c023e8081a0fffa23a360b83d1164650e5f32386061e08a152b9c4b0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.2.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/50.2.0 requests-toolbelt/0.9.1 tqdm/4.38.0 CPython/3.7.3
|
Security for serotools 0.2.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.