mirror of https://github.com/msberends/AMR.git
217 lines
8.9 KiB
R
217 lines
8.9 KiB
R
% Generated by roxygen2: do not edit by hand
|
|
% Please edit documentation in R/plot.R
|
|
\name{plot}
|
|
\alias{plot}
|
|
\alias{scale_x_mic}
|
|
\alias{scale_y_mic}
|
|
\alias{scale_colour_mic}
|
|
\alias{scale_fill_mic}
|
|
\alias{plot.mic}
|
|
\alias{autoplot.mic}
|
|
\alias{fortify.mic}
|
|
\alias{plot.disk}
|
|
\alias{autoplot.disk}
|
|
\alias{fortify.disk}
|
|
\alias{plot.sir}
|
|
\alias{autoplot.sir}
|
|
\alias{fortify.sir}
|
|
\title{Plotting for Classes \code{sir}, \code{mic} and \code{disk}}
|
|
\usage{
|
|
scale_x_mic(keep_operators = "edges", mic_range = NULL, drop = FALSE, ...)
|
|
|
|
scale_y_mic(keep_operators = "edges", mic_range = NULL, drop = FALSE, ...)
|
|
|
|
scale_colour_mic(keep_operators = "edges", mic_range = NULL, drop = FALSE, ...)
|
|
|
|
scale_fill_mic(keep_operators = "edges", mic_range = NULL, drop = FALSE, ...)
|
|
|
|
\method{plot}{mic}(
|
|
x,
|
|
mo = NULL,
|
|
ab = NULL,
|
|
guideline = "EUCAST",
|
|
main = deparse(substitute(x)),
|
|
ylab = translate_AMR("Frequency", language = language),
|
|
xlab = translate_AMR("Minimum Inhibitory Concentration (mg/L)", language = language),
|
|
colours_SIR = c("#3CAEA3", "#F6D55C", "#ED553B"),
|
|
language = get_AMR_locale(),
|
|
expand = TRUE,
|
|
include_PKPD = getOption("AMR_include_PKPD", TRUE),
|
|
breakpoint_type = getOption("AMR_breakpoint_type", "human"),
|
|
...
|
|
)
|
|
|
|
\method{autoplot}{mic}(
|
|
object,
|
|
mo = NULL,
|
|
ab = NULL,
|
|
guideline = "EUCAST",
|
|
title = deparse(substitute(object)),
|
|
ylab = translate_AMR("Frequency", language = language),
|
|
xlab = translate_AMR("Minimum Inhibitory Concentration (mg/L)", language = language),
|
|
colours_SIR = c("#3CAEA3", "#F6D55C", "#ED553B"),
|
|
language = get_AMR_locale(),
|
|
expand = TRUE,
|
|
include_PKPD = getOption("AMR_include_PKPD", TRUE),
|
|
breakpoint_type = getOption("AMR_breakpoint_type", "human"),
|
|
...
|
|
)
|
|
|
|
\method{fortify}{mic}(object, ...)
|
|
|
|
\method{plot}{disk}(
|
|
x,
|
|
main = deparse(substitute(x)),
|
|
ylab = translate_AMR("Frequency", language = language),
|
|
xlab = translate_AMR("Disk diffusion diameter (mm)", language = language),
|
|
mo = NULL,
|
|
ab = NULL,
|
|
guideline = "EUCAST",
|
|
colours_SIR = c("#3CAEA3", "#F6D55C", "#ED553B"),
|
|
language = get_AMR_locale(),
|
|
expand = TRUE,
|
|
include_PKPD = getOption("AMR_include_PKPD", TRUE),
|
|
breakpoint_type = getOption("AMR_breakpoint_type", "human"),
|
|
...
|
|
)
|
|
|
|
\method{autoplot}{disk}(
|
|
object,
|
|
mo = NULL,
|
|
ab = NULL,
|
|
title = deparse(substitute(object)),
|
|
ylab = translate_AMR("Frequency", language = language),
|
|
xlab = translate_AMR("Disk diffusion diameter (mm)", language = language),
|
|
guideline = "EUCAST",
|
|
colours_SIR = c("#3CAEA3", "#F6D55C", "#ED553B"),
|
|
language = get_AMR_locale(),
|
|
expand = TRUE,
|
|
include_PKPD = getOption("AMR_include_PKPD", TRUE),
|
|
breakpoint_type = getOption("AMR_breakpoint_type", "human"),
|
|
...
|
|
)
|
|
|
|
\method{fortify}{disk}(object, ...)
|
|
|
|
\method{plot}{sir}(
|
|
x,
|
|
ylab = translate_AMR("Percentage", language = language),
|
|
xlab = translate_AMR("Antimicrobial Interpretation", language = language),
|
|
main = deparse(substitute(x)),
|
|
language = get_AMR_locale(),
|
|
...
|
|
)
|
|
|
|
\method{autoplot}{sir}(
|
|
object,
|
|
title = deparse(substitute(object)),
|
|
xlab = translate_AMR("Antimicrobial Interpretation", language = language),
|
|
ylab = translate_AMR("Frequency", language = language),
|
|
colours_SIR = c("#3CAEA3", "#F6D55C", "#ED553B"),
|
|
language = get_AMR_locale(),
|
|
...
|
|
)
|
|
|
|
\method{fortify}{sir}(object, ...)
|
|
}
|
|
\arguments{
|
|
\item{keep_operators}{a \link{character} specifying how to handle operators (such as \code{>} and \code{<=}) in the input. Accepts one of three values: \code{"all"} (or \code{TRUE}) to keep all operators, \code{"none"} (or \code{FALSE}) to remove all operators, or \code{"edges"} to keep operators only at both ends of the range.}
|
|
|
|
\item{mic_range}{a manual range to limit the MIC values, e.g., \code{mic_range = c(0.001, 32)}. Use \code{NA} to set no limit on one side, e.g., \code{mic_range = c(NA, 32)}.}
|
|
|
|
\item{drop}{a \link{logical} to remove intermediate MIC values, defaults to \code{FALSE}}
|
|
|
|
\item{...}{arguments passed on to methods}
|
|
|
|
\item{x, object}{values created with \code{\link[=as.mic]{as.mic()}}, \code{\link[=as.disk]{as.disk()}} or \code{\link[=as.sir]{as.sir()}} (or their \verb{random_*} variants, such as \code{\link[=random_mic]{random_mic()}})}
|
|
|
|
\item{mo}{any (vector of) text that can be coerced to a valid microorganism code with \code{\link[=as.mo]{as.mo()}}}
|
|
|
|
\item{ab}{any (vector of) text that can be coerced to a valid antimicrobial drug code with \code{\link[=as.ab]{as.ab()}}}
|
|
|
|
\item{guideline}{interpretation guideline to use - the default is the latest included EUCAST guideline, see \emph{Details}}
|
|
|
|
\item{main, title}{title of the plot}
|
|
|
|
\item{xlab, ylab}{axis title}
|
|
|
|
\item{colours_SIR}{colours to use for filling in the bars, must be a vector of three values (in the order S, I and R). The default colours are colour-blind friendly.}
|
|
|
|
\item{language}{language to be used to translate 'Susceptible', 'Increased exposure'/'Intermediate' and 'Resistant' - the default is system language (see \code{\link[=get_AMR_locale]{get_AMR_locale()}}) and can be overwritten by setting the \link[=AMR-options]{package option} \code{\link[=AMR-options]{AMR_locale}}, e.g. \code{options(AMR_locale = "de")}, see \link{translate}. Use \code{language = NULL} or \code{language = ""} to prevent translation.}
|
|
|
|
\item{expand}{a \link{logical} to indicate whether the range on the x axis should be expanded between the lowest and highest value. For MIC values, intermediate values will be factors of 2 starting from the highest MIC value. For disk diameters, the whole diameter range will be filled.}
|
|
|
|
\item{include_PKPD}{a \link{logical} to indicate that PK/PD clinical breakpoints must be applied as a last resort - the default is \code{TRUE}. Can also be set with the \link[=AMR-options]{package option} \code{\link[=AMR-options]{AMR_include_PKPD}}.}
|
|
|
|
\item{breakpoint_type}{the type of breakpoints to use, either "ECOFF", "animal", or "human". ECOFF stands for Epidemiological Cut-Off values. The default is \code{"human"}, which can also be set with the \link[=AMR-options]{package option} \code{\link[=AMR-options]{AMR_breakpoint_type}}. If \code{host} is set to values of veterinary species, this will automatically be set to \code{"animal"}.}
|
|
}
|
|
\value{
|
|
The \code{autoplot()} functions return a \code{\link[ggplot2:ggplot]{ggplot}} model that is extendible with any \code{ggplot2} function.
|
|
|
|
The \code{fortify()} functions return a \link{data.frame} as an extension for usage in the \code{\link[ggplot2:ggplot]{ggplot2::ggplot()}} function.
|
|
}
|
|
\description{
|
|
Functions to plot classes \code{sir}, \code{mic} and \code{disk}, with support for base \R and \code{ggplot2}.
|
|
|
|
Especially the \verb{scale_*_mic()} functions are relevant wrappers to plot MIC values for \code{ggplot2}. They allows custom MIC ranges and to plot intermediate log2 levels for missing MIC values.
|
|
}
|
|
\details{
|
|
The interpretation of "I" will be named "Increased exposure" for all EUCAST guidelines since 2019, and will be named "Intermediate" in all other cases.
|
|
|
|
For interpreting MIC values as well as disk diffusion diameters, supported guidelines to be used as input for the \code{guideline} argument are: "EUCAST 2023", "EUCAST 2022", "EUCAST 2021", "EUCAST 2020", "EUCAST 2019", "EUCAST 2018", "EUCAST 2017", "EUCAST 2016", "EUCAST 2015", "EUCAST 2014", "EUCAST 2013", "EUCAST 2012", "EUCAST 2011", "CLSI 2023", "CLSI 2022", "CLSI 2021", "CLSI 2020", "CLSI 2019", "CLSI 2018", "CLSI 2017", "CLSI 2016", "CLSI 2015", "CLSI 2014", "CLSI 2013", "CLSI 2012", and "CLSI 2011".
|
|
|
|
Simply using \code{"CLSI"} or \code{"EUCAST"} as input will automatically select the latest version of that guideline.
|
|
}
|
|
\examples{
|
|
some_mic_values <- random_mic(size = 100)
|
|
some_disk_values <- random_disk(size = 100, mo = "Escherichia coli", ab = "cipro")
|
|
some_sir_values <- random_sir(50, prob_SIR = c(0.55, 0.05, 0.30))
|
|
|
|
plot(some_mic_values)
|
|
plot(some_disk_values)
|
|
plot(some_sir_values)
|
|
|
|
# when providing the microorganism and antibiotic, colours will show interpretations:
|
|
plot(some_mic_values, mo = "S. aureus", ab = "ampicillin")
|
|
plot(some_disk_values, mo = "Escherichia coli", ab = "cipro")
|
|
plot(some_disk_values, mo = "Escherichia coli", ab = "cipro", language = "nl")
|
|
|
|
|
|
# Plotting using scale_x_mic()
|
|
\donttest{
|
|
if (require("ggplot2")) {
|
|
mic_plot <- ggplot(data.frame(mics = as.mic(c(0.125, "<=4", 4, 8, 32, ">=32")),
|
|
counts = c(1, 1, 2, 2, 3, 3)),
|
|
aes(mics, counts)) +
|
|
geom_col()
|
|
mic_plot +
|
|
labs(title = "without scale_x_mic()")
|
|
}
|
|
if (require("ggplot2")) {
|
|
mic_plot +
|
|
scale_x_mic() +
|
|
labs(title = "with scale_x_mic()")
|
|
}
|
|
if (require("ggplot2")) {
|
|
mic_plot +
|
|
scale_x_mic(keep_operators = "all") +
|
|
labs(title = "with scale_x_mic() keeping all operators")
|
|
}
|
|
if (require("ggplot2")) {
|
|
mic_plot +
|
|
scale_x_mic(mic_range = c(1, 128)) +
|
|
labs(title = "with scale_x_mic() using a manual range")
|
|
}
|
|
|
|
if (require("ggplot2")) {
|
|
autoplot(some_mic_values)
|
|
}
|
|
if (require("ggplot2")) {
|
|
autoplot(some_disk_values, mo = "Escherichia coli", ab = "cipro")
|
|
}
|
|
if (require("ggplot2")) {
|
|
autoplot(some_sir_values)
|
|
}
|
|
}
|
|
}
|