mirror of https://github.com/msberends/AMR.git
47 lines
3.2 KiB
R
47 lines
3.2 KiB
R
% Generated by roxygen2: do not edit by hand
|
|
% Please edit documentation in R/catalogue_of_life.R
|
|
\name{catalogue_of_life_version}
|
|
\alias{catalogue_of_life_version}
|
|
\title{Version info of included Catalogue of Life}
|
|
\usage{
|
|
catalogue_of_life_version()
|
|
}
|
|
\description{
|
|
This function returns a list with info about the included data from the Catalogue of Life. It also shows if the included version is their latest annual release. The Catalogue of Life releases their annual release in March each year.
|
|
}
|
|
\details{
|
|
The list item \code{is_latest_annual_release} is based on the system date.
|
|
}
|
|
\section{Catalogue of Life}{
|
|
|
|
\if{html}{\figure{logo_col.png}{options: height=60px style=margin-bottom:5px} \cr}
|
|
This package contains the complete taxonomic tree of almost all microorganisms from the authoritative and comprehensive Catalogue of Life (\url{http://www.catalogueoflife.org}). This data is updated annually - check the included version with \code{\link{catalogue_of_life_version}()}.
|
|
|
|
Included are:
|
|
\itemize{
|
|
\item{All ~55,000 (sub)species from the kingdoms of Archaea, Bacteria, Protozoa and Viruses}
|
|
\item{All ~3,500 (sub)species from these orders of the kingdom of Fungi: Eurotiales, Onygenales, Pneumocystales, Saccharomycetales, Schizosaccharomycetales and Tremellales. This covers the most relevant microbial fungi (like all species of \emph{Aspergillus}, \emph{Candida}, \emph{Cryptococcus}, \emph{Histplasma}, \emph{Pneumocystis}, \emph{Saccharomyces} and \emph{Trichophyton}).}
|
|
\item{All ~15,000 previously accepted names of included (sub)species that have been taxonomically renamed}
|
|
\item{The complete taxonomic tree of all included (sub)species: from kingdom to subspecies}
|
|
\item{The responsible author(s) and year of scientific publication}
|
|
}
|
|
|
|
The Catalogue of Life (\url{http://www.catalogueoflife.org}) is the most comprehensive and authoritative global index of species currently available. It holds essential information on the names, relationships and distributions of over 1.6 million species. The Catalogue of Life is used to support the major biodiversity and conservation information services such as the Global Biodiversity Information Facility (GBIF), Encyclopedia of Life (EoL) and the International Union for Conservation of Nature Red List. It is recognised by the Convention on Biological Diversity as a significant component of the Global Taxonomy Initiative and a contribution to Target 1 of the Global Strategy for Plant Conservation.
|
|
|
|
The syntax used to transform the original data to a cleansed R format, can be found here: \url{https://gitlab.com/msberends/AMR/blob/master/reproduction_of_microorganisms.R}.
|
|
}
|
|
|
|
\section{Read more on our website!}{
|
|
|
|
On our website \url{https://msberends.gitlab.io/AMR} you can find \href{https://msberends.gitlab.io/AMR/articles/AMR.html}{a comprehensive tutorial} about how to conduct AMR analysis, the \href{https://msberends.gitlab.io/AMR/reference}{complete documentation of all functions} (which reads a lot easier than here in R) and \href{https://msberends.gitlab.io/AMR/articles/WHONET.html}{an example analysis using WHONET data}.
|
|
}
|
|
|
|
\examples{
|
|
library(dplyr)
|
|
microorganisms \%>\% freq(kingdom)
|
|
microorganisms \%>\% group_by(kingdom) \%>\% freq(phylum, nmax = NULL)
|
|
}
|
|
\seealso{
|
|
\code{\link{microorganisms}}
|
|
}
|