mirror of https://github.com/msberends/AMR.git
41 lines
1.9 KiB
R
41 lines
1.9 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()
|
|
}
|
|
\value{
|
|
a \code{list}, which prints in pretty format
|
|
}
|
|
\description{
|
|
This function returns information 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{...$catalogue_of_life$is_latest_annual_release} is based on the system date.
|
|
|
|
For DSMZ, see \code{?microorganisms}.
|
|
}
|
|
\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 (~65,000 species) from the authoritative and comprehensive Catalogue of Life (\url{http://www.catalogueoflife.org}). The Catalogue of Life is the most comprehensive and authoritative global index of species currently available.
|
|
|
|
\link[=catalogue_of_life]{Click here} for more information about the included taxa. The Catalogue of Life releases updates annually; check which version was included in this package with \code{\link{catalogue_of_life_version}()}.
|
|
}
|
|
|
|
\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}}
|
|
}
|