Package: serotools
This package serves as a toolkit and repository for the White-Kauffmann-Le Minor scheme forSalmonellaserotyping, 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 softwareDocumentation:https://serotools.readthedocs.ioSource Code:https://github.com/CFSAN-Biostatistics/serotoolsPyPI Distribution:https://pypi.python.org/pypi/serotoolsIntroductionSalmonellabacteria 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) ofSalmonellahas 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)Salmonellaserotyping scheme specifies the commonly accepted naming and formatting conventions forSalmonellaserotyping data and the antigenic factors (and other characteristics) which define each serovar.Salmonellaserotyping 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 ofSalmonellaserotyping data. As technological advances continue to produce a range of high resolution subtyping options, includingin silicoserovar 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.[1]The U.S. Centers for Disease Control and Prevention. <https://www.cdc.gov/salmonella/index.html>.FeaturesQuery the White-Kauffmann-Le MinorSalmonellaserotyping repositoryCompare serovar predictions for state of congruenceDetermine the most abundant serovar for a cluster of isolatesCiting SeroToolsTo cite SeroTools, please reference the SeroTools GitHub repository:https://github.com/CFSAN-Biostatistics/serotoolsLicenseSee the LICENSE file included in the SeroTools distribution.History0.2.1 (2020-09-04)Updated documentationAdded JOSS manuscript0.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.pyUpdated the algorithm for minimally congruent serovars0.1.0 (2019-11-19)Initial version.