mirror of
https://github.com/msberends/AMR.git
synced 2024-12-25 18:46:11 +01:00
74 lines
2.6 KiB
R
74 lines
2.6 KiB
R
% Generated by roxygen2: do not edit by hand
|
|
% Please edit documentation in R/disk.R
|
|
\docType{data}
|
|
\name{as.disk}
|
|
\alias{as.disk}
|
|
\alias{disk}
|
|
\alias{NA_disk_}
|
|
\alias{is.disk}
|
|
\title{Transform Input to Disk Diffusion Diameters}
|
|
\format{
|
|
An object of class \code{disk} (inherits from \code{integer}) of length 1.
|
|
}
|
|
\usage{
|
|
as.disk(x, na.rm = FALSE)
|
|
|
|
NA_disk_
|
|
|
|
is.disk(x)
|
|
}
|
|
\arguments{
|
|
\item{x}{vector}
|
|
|
|
\item{na.rm}{a \link{logical} indicating whether missing values should be removed}
|
|
}
|
|
\value{
|
|
An \link{integer} with additional class \code{\link{disk}}
|
|
}
|
|
\description{
|
|
This transforms a vector to a new class \code{\link{disk}}, which is a disk diffusion growth zone size (around an antibiotic disk) in millimetres between 6 and 50.
|
|
}
|
|
\details{
|
|
Interpret disk values as RSI values with \code{\link[=as.rsi]{as.rsi()}}. It supports guidelines from EUCAST and CLSI.
|
|
|
|
\code{NA_disk_} is a missing value of the new \verb{<disk>} class.
|
|
}
|
|
\section{Stable Lifecycle}{
|
|
|
|
\if{html}{\figure{lifecycle_stable.svg}{options: style=margin-bottom:5px} \cr}
|
|
The \link[=lifecycle]{lifecycle} of this function is \strong{stable}. In a stable function, major changes are unlikely. This means that the unlying code will generally evolve by adding new arguments; removing arguments or changing the meaning of existing arguments will be avoided.
|
|
|
|
If the unlying code needs breaking changes, they will occur gradually. For example, an argument will be deprecated and first continue to work, but will emit an message informing you of the change. Next, typically after at least one newly released version on CRAN, the message will be transformed to an error.
|
|
}
|
|
|
|
\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}.
|
|
}
|
|
|
|
\examples{
|
|
\donttest{
|
|
# transform existing disk zones to the `disk` class
|
|
df <- data.frame(microorganism = "E. coli",
|
|
AMP = 20,
|
|
CIP = 14,
|
|
GEN = 18,
|
|
TOB = 16)
|
|
df[, 2:5] <- lapply(df[, 2:5], as.disk)
|
|
# same with dplyr:
|
|
# df \%>\% mutate(across(AMP:TOB, as.disk))
|
|
|
|
# interpret disk values, see ?as.rsi
|
|
as.rsi(x = as.disk(18),
|
|
mo = "Strep pneu", # `mo` will be coerced with as.mo()
|
|
ab = "ampicillin", # and `ab` with as.ab()
|
|
guideline = "EUCAST")
|
|
|
|
as.rsi(df)
|
|
}
|
|
}
|
|
\seealso{
|
|
\code{\link[=as.rsi]{as.rsi()}}
|
|
}
|
|
\keyword{datasets}
|