mirror of https://github.com/msberends/AMR.git
107 lines
8.2 KiB
R
Executable File
107 lines
8.2 KiB
R
Executable File
% Generated by roxygen2: do not edit by hand
|
|
% Please edit documentation in R/data.R
|
|
\docType{data}
|
|
\name{microorganisms}
|
|
\alias{microorganisms}
|
|
\title{Data Set with 70,760 Microorganisms}
|
|
\format{
|
|
A \link{data.frame} with 70,760 observations and 16 variables:
|
|
\itemize{
|
|
\item \code{mo}\cr ID of microorganism as used by this package
|
|
\item \code{fullname}\cr Full name, like \code{"Escherichia coli"}
|
|
\item \code{kingdom}, \code{phylum}, \code{class}, \code{order}, \code{family}, \code{genus}, \code{species}, \code{subspecies}\cr Taxonomic rank of the microorganism
|
|
\item \code{rank}\cr Text of the taxonomic rank of the microorganism, like \code{"species"} or \code{"genus"}
|
|
\item \code{ref}\cr Author(s) and year of concerning scientific publication
|
|
\item \code{species_id}\cr ID of the species as used by the Catalogue of Life
|
|
\item \code{source}\cr Either "CoL", "LPSN" or "manually added" (see \emph{Source})
|
|
\item \code{prevalence}\cr Prevalence of the microorganism, see \code{\link[=as.mo]{as.mo()}}
|
|
\item \code{snomed}\cr Systematized Nomenclature of Medicine (SNOMED) code of the microorganism, according to the US Edition of SNOMED CT from 1 September 2020 (see \emph{Source}). Use \code{\link[=mo_snomed]{mo_snomed()}} to retrieve it quickly, see \code{\link[=mo_property]{mo_property()}}.
|
|
}
|
|
}
|
|
\source{
|
|
Catalogue of Life: 2019 Annual Checklist as currently implemented in this \code{AMR} package:
|
|
\itemize{
|
|
\item Annual Checklist (public online taxonomic database), \url{http://www.catalogueoflife.org}
|
|
}
|
|
|
|
List of Prokaryotic names with Standing in Nomenclature (5 October 2021) as currently implemented in this \code{AMR} package:
|
|
\itemize{
|
|
\item Parte, A.C., Sarda Carbasse, J., Meier-Kolthoff, J.P., Reimer, L.C. and Goker, M. (2020). List of Prokaryotic names with Standing in Nomenclature (LPSN) moves to the DSMZ. International Journal of Systematic and Evolutionary Microbiology, 70, 5607-5612; \doi{10.1099/ijsem.0.004332}
|
|
\item Parte, A.C. (2018). LPSN - List of Prokaryotic names with Standing in Nomenclature (bacterio.net), 20 years on. International Journal of Systematic and Evolutionary Microbiology, 68, 1825-1829; \doi{10.1099/ijsem.0.002786}
|
|
\item Parte, A.C. (2014). LPSN - List of Prokaryotic names with Standing in Nomenclature. Nucleic Acids Research, 42, Issue D1, D613-D616; \doi{10.1093/nar/gkt1111}
|
|
\item Euzeby, J.P. (1997). List of Bacterial Names with Standing in Nomenclature: a Folder Available on the Internet. International Journal of Systematic Bacteriology, 47, 590-592; \doi{10.1099/00207713-47-2-590}
|
|
}
|
|
|
|
US Edition of SNOMED CT from 1 September 2020 as currently implemented in this \code{AMR} package:
|
|
\itemize{
|
|
\item Retrieved from the Public Health Information Network Vocabulary Access and Distribution System (PHIN VADS), OID 2.16.840.1.114222.4.11.1009, version 12; url: \url{https://phinvads.cdc.gov/vads/ViewValueSet.action?oid=2.16.840.1.114222.4.11.1009}
|
|
}
|
|
}
|
|
\usage{
|
|
microorganisms
|
|
}
|
|
\description{
|
|
A data set containing the full microbial taxonomy (\strong{last updated: 5 October 2021}) of six kingdoms from the Catalogue of Life (CoL) and the List of Prokaryotic names with Standing in Nomenclature (LPSN). MO codes can be looked up using \code{\link[=as.mo]{as.mo()}}.
|
|
}
|
|
\details{
|
|
Please note that entries are only based on the Catalogue of Life and the LPSN (see below). Since these sources incorporate entries based on (recent) publications in the International Journal of Systematic and Evolutionary Microbiology (IJSEM), it can happen that the year of publication is sometimes later than one might expect.
|
|
|
|
For example, \emph{Staphylococcus pettenkoferi} was described for the first time in Diagnostic Microbiology and Infectious Disease in 2002 (\doi{10.1016/s0732-8893(02)00399-1}), but it was not before 2007 that a publication in IJSEM followed (\doi{10.1099/ijs.0.64381-0}). Consequently, the \code{AMR} package returns 2007 for \code{mo_year("S. pettenkoferi")}.
|
|
\subsection{Manual additions}{
|
|
|
|
For convenience, some entries were added manually:
|
|
\itemize{
|
|
\item 11 entries of \emph{Streptococcus} (beta-haemolytic: groups A, B, C, D, F, G, H, K and unspecified; other: viridans, milleri)
|
|
\item 2 entries of \emph{Staphylococcus} (coagulase-negative (CoNS) and coagulase-positive (CoPS))
|
|
\item 3 entries of \emph{Trichomonas} (\emph{T. vaginalis}, and its family and genus)
|
|
\item 1 entry of \emph{Candida} (\emph{C. krusei}), that is not (yet) in the Catalogue of Life
|
|
\item 1 entry of \emph{Blastocystis} (\emph{B. hominis}), although it officially does not exist (Noel \emph{et al.} 2005, PMID 15634993)
|
|
\item 1 entry of \emph{Moraxella} (\emph{M. catarrhalis}), which was formally named \emph{Branhamella catarrhalis} (Catlin, 1970) though this change was never accepted within the field of clinical microbiology
|
|
\item 5 other 'undefined' entries (unknown, unknown Gram negatives, unknown Gram positives, unknown yeast and unknown fungus)
|
|
\item 6 families under the Enterobacterales order, according to Adeolu \emph{et al.} (2016, PMID 27620848), that are not (yet) in the Catalogue of Life
|
|
}
|
|
}
|
|
|
|
\subsection{Direct download}{
|
|
|
|
This data set is available as 'flat file' for use even without \R - you can find the file here:
|
|
\itemize{
|
|
\item \url{https://github.com/msberends/AMR/raw/main/data-raw/microorganisms.txt}
|
|
}
|
|
|
|
The file in \R format (with preserved data structure) can be found here:
|
|
\itemize{
|
|
\item \url{https://github.com/msberends/AMR/raw/main/data/microorganisms.rda}
|
|
}
|
|
}
|
|
}
|
|
\section{About the Records from LPSN (see \emph{Source})}{
|
|
|
|
The List of Prokaryotic names with Standing in Nomenclature (LPSN) provides comprehensive information on the nomenclature of prokaryotes. LPSN is a free to use service founded by Jean P. Euzeby in 1997 and later on maintained by Aidan C. Parte.
|
|
|
|
As of February 2020, the regularly augmented LPSN database at DSMZ is the basis of the new LPSN service. The new database was implemented for the Type-Strain Genome Server and augmented in 2018 to store all kinds of nomenclatural information. Data from the previous version of LPSN and from the Prokaryotic Nomenclature Up-to-date (PNU) service were imported into the new system. PNU had been established in 1993 as a service of the Leibniz Institute DSMZ, and was curated by Norbert Weiss, Manfred Kracht and Dorothea Gleim.
|
|
}
|
|
|
|
\section{Catalogue of Life}{
|
|
|
|
\if{html}{\figure{logo_col.png}{options: height=40px style=margin-bottom:5px} \cr}
|
|
This package contains the complete taxonomic tree of almost all microorganisms (~71,000 species) from the authoritative and comprehensive Catalogue of Life (CoL, \url{http://www.catalogueoflife.org}). The CoL is the most comprehensive and authoritative global index of species currently available. Nonetheless, we supplemented the CoL data with data from the List of Prokaryotic names with Standing in Nomenclature (LPSN, \href{https://lpsn.dsmz.de}{lpsn.dsmz.de}). This supplementation is needed until the \href{https://github.com/CatalogueOfLife/general}{CoL+ project} is finished, which we await.
|
|
|
|
\link[=catalogue_of_life]{Click here} for more information about the included taxa. Check which versions of the CoL and LPSN were included in this package with \code{\link[=catalogue_of_life_version]{catalogue_of_life_version()}}.
|
|
}
|
|
|
|
\section{Reference Data Publicly Available}{
|
|
|
|
All reference data sets (about microorganisms, antibiotics, R/SI interpretation, EUCAST rules, etc.) in this \code{AMR} package are publicly and freely available. We continually export our data sets to formats for use in R, SPSS, SAS, Stata and Excel. We also supply flat files that are machine-readable and suitable for input in any software program, such as laboratory information systems. Please find \href{https://msberends.github.io/AMR/articles/datasets.html}{all download links on our website}, which is automatically updated with every code change.
|
|
}
|
|
|
|
\section{Read more on Our Website!}{
|
|
|
|
On our website \url{https://msberends.github.io/AMR/} you can find \href{https://msberends.github.io/AMR/articles/AMR.html}{a comprehensive tutorial} about how to conduct AMR data analysis, the \href{https://msberends.github.io/AMR/reference/}{complete documentation of all functions} and \href{https://msberends.github.io/AMR/articles/WHONET.html}{an example analysis using WHONET data}.
|
|
}
|
|
|
|
\seealso{
|
|
\code{\link[=as.mo]{as.mo()}}, \code{\link[=mo_property]{mo_property()}}, \link{microorganisms.codes}, \link{intrinsic_resistant}
|
|
}
|
|
\keyword{datasets}
|