AMR/man/ggplot_rsi.Rd

190 lines
8.3 KiB
Plaintext
Raw Normal View History

2018-08-11 21:30:00 +02:00
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/ggplot_rsi.R
\name{ggplot_rsi}
\alias{ggplot_rsi}
\alias{geom_rsi}
\alias{facet_rsi}
\alias{scale_y_percent}
\alias{scale_rsi_colours}
\alias{theme_rsi}
2018-09-16 22:11:17 +02:00
\alias{labels_rsi_count}
2019-01-27 19:30:40 +01:00
\title{AMR plots with \code{ggplot2}}
2018-08-11 21:30:00 +02:00
\usage{
2018-08-22 00:02:26 +02:00
ggplot_rsi(data, position = NULL, x = "Antibiotic",
fill = "Interpretation", facet = NULL, breaks = seq(0, 1, 0.1),
2019-05-13 10:10:16 +02:00
limits = NULL, translate_ab = "name", combine_SI = TRUE,
combine_IR = FALSE, language = get_locale(), fun = count_df,
nrow = NULL, datalabels = TRUE, datalabels.size = 3,
datalabels.colour = "grey15", ...)
2018-08-11 21:30:00 +02:00
2018-08-22 00:02:26 +02:00
geom_rsi(position = NULL, x = c("Antibiotic", "Interpretation"),
2019-05-10 16:44:59 +02:00
fill = "Interpretation", translate_ab = "name",
2019-05-13 10:10:16 +02:00
language = get_locale(), combine_SI = TRUE, combine_IR = FALSE,
fun = count_df, ...)
2018-08-11 21:30:00 +02:00
2018-08-29 16:35:32 +02:00
facet_rsi(facet = c("Interpretation", "Antibiotic"), nrow = NULL)
2018-08-11 21:30:00 +02:00
scale_y_percent(breaks = seq(0, 1, 0.1), limits = NULL)
2018-08-11 21:30:00 +02:00
scale_rsi_colours()
theme_rsi()
2018-09-16 22:11:17 +02:00
labels_rsi_count(position = NULL, x = "Antibiotic",
datalabels.size = 3, datalabels.colour = "grey15")
2018-08-11 21:30:00 +02:00
}
\arguments{
\item{data}{a \code{data.frame} with column(s) of class \code{"rsi"} (see \code{\link{as.rsi}})}
2018-09-16 22:11:17 +02:00
\item{position}{position adjustment of bars, either \code{"fill"} (default when \code{fun} is \code{\link{count_df}}), \code{"stack"} (default when \code{fun} is \code{\link{portion_df}}) or \code{"dodge"}}
2018-08-11 21:30:00 +02:00
2018-08-13 16:42:37 +02:00
\item{x}{variable to show on x axis, either \code{"Antibiotic"} (default) or \code{"Interpretation"} or a grouping variable}
2018-08-11 21:30:00 +02:00
2018-08-13 16:42:37 +02:00
\item{fill}{variable to categorise using the plots legend, either \code{"Antibiotic"} (default) or \code{"Interpretation"} or a grouping variable}
2018-08-13 16:42:37 +02:00
\item{facet}{variable to split plots by, either \code{"Interpretation"} (default) or \code{"Antibiotic"} or a grouping variable}
\item{breaks}{numeric vector of positions}
\item{limits}{numeric vector of length two providing limits of the scale, use \code{NA} to refer to the existing minimum or maximum}
2019-05-13 10:10:16 +02:00
\item{translate_ab}{a column name of the \code{\link{antibiotics}} data set to translate the antibiotic abbreviations to, using \code{\link{ab_property}}}
2019-05-10 16:44:59 +02:00
2019-05-23 16:58:59 +02:00
\item{combine_SI}{a logical to indicate whether all values of S and I must be merged into one, so the output only consists of S+I vs. R (susceptible vs. resistant). This used to be the parameter \code{combine_IR}, but this now follows the redefinition by EUCAST about the interpretion of I (increased exposure) in 2019, see section 'Interpretation of S, I and R' below. Default is \code{TRUE}.}
2019-05-13 12:21:57 +02:00
\item{combine_IR}{a logical to indicate whether all values of I and R must be merged into one, so the output only consists of S vs. I+R (susceptible vs. non-susceptible). This is outdated, see parameter \code{combine_SI}.}
2019-05-13 10:10:16 +02:00
\item{language}{language of the returned text, defaults to system language (see \code{\link{get_locale}}) and can also be set with \code{\link{getOption}("AMR_locale")}. Use \code{language = NULL} or \code{language = ""} to prevent translation.}
2018-08-13 16:42:37 +02:00
2018-09-16 22:11:17 +02:00
\item{fun}{function to transform \code{data}, either \code{\link{count_df}} (default) or \code{\link{portion_df}}}
2018-08-22 00:02:26 +02:00
2018-08-29 16:35:32 +02:00
\item{nrow}{(when using \code{facet}) number of rows}
2018-09-16 22:11:17 +02:00
\item{datalabels}{show datalabels using \code{labels_rsi_count}, will at default only be shown when \code{fun = count_df}}
\item{datalabels.size}{size of the datalabels}
\item{datalabels.colour}{colour of the datalabels}
2018-08-23 21:27:15 +02:00
\item{...}{other parameters passed on to \code{geom_rsi}}
2018-08-11 21:30:00 +02:00
}
\description{
2018-08-12 17:44:06 +02:00
Use these functions to create bar plots for antimicrobial resistance analysis. All functions rely on internal \code{\link[ggplot2]{ggplot}} functions.
2018-08-11 21:30:00 +02:00
}
\details{
2019-05-10 16:44:59 +02:00
At default, the names of antibiotics will be shown on the plots using \code{\link{ab_name}}. This can be set with the option \code{get_antibiotic_names} (a logical value), so change it e.g. to \code{FALSE} with \code{options(get_antibiotic_names = FALSE)}.
2018-08-11 21:30:00 +02:00
\strong{The functions}\cr
2018-09-17 20:53:32 +02:00
\code{geom_rsi} will take any variable from the data that has an \code{rsi} class (created with \code{\link{as.rsi}}) using \code{fun} (\code{\link{count_df}} at default, can also be \code{\link{portion_df}}) and will plot bars with the percentage R, I and S. The default behaviour is to have the bars stacked and to have the different antibiotics on the x axis.
2018-08-11 21:30:00 +02:00
2018-08-12 17:44:06 +02:00
\code{facet_rsi} creates 2d plots (at default based on S/I/R) using \code{\link[ggplot2]{facet_wrap}}.
2018-08-11 21:30:00 +02:00
2018-09-17 20:53:32 +02:00
\code{scale_y_percent} transforms the y axis to a 0 to 100\% range using \code{\link[ggplot2]{scale_continuous}}.
2018-08-11 21:30:00 +02:00
2018-10-12 16:35:18 +02:00
\code{scale_rsi_colours} sets colours to the bars: green for S, yellow for I and red for R, using \code{\link[ggplot2]{scale_brewer}}.
2018-08-11 21:30:00 +02:00
2018-09-17 20:53:32 +02:00
\code{theme_rsi} is a \code{ggplot \link[ggplot2]{theme}} with minimal distraction.
2018-08-11 21:30:00 +02:00
2018-09-16 22:11:17 +02:00
\code{labels_rsi_count} print datalabels on the bars with percentage and amount of isolates using \code{\link[ggplot2]{geom_text}}
2018-08-11 21:30:00 +02:00
\code{ggplot_rsi} is a wrapper around all above functions that uses data as first input. This makes it possible to use this function after a pipe (\code{\%>\%}). See Examples.
}
2019-01-02 23:24:07 +01:00
\section{Read more on our website!}{
2019-01-29 20:20:09 +01:00
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}.
2019-01-02 23:24:07 +01:00
}
2018-08-11 21:30:00 +02:00
\examples{
library(dplyr)
library(ggplot2)
# get antimicrobial results for drugs against a UTI:
2019-05-10 16:44:59 +02:00
ggplot(septic_patients \%>\% select(AMX, NIT, FOS, TMP, CIP)) +
2018-08-11 21:30:00 +02:00
geom_rsi()
2018-08-13 16:42:37 +02:00
# prettify the plot using some additional functions:
2019-05-10 16:44:59 +02:00
df <- septic_patients[, c("AMX", "NIT", "FOS", "TMP", "CIP")]
2018-08-11 21:30:00 +02:00
ggplot(df) +
2018-08-13 16:42:37 +02:00
geom_rsi() +
2018-08-11 21:30:00 +02:00
scale_y_percent() +
scale_rsi_colours() +
2018-09-16 22:11:17 +02:00
labels_rsi_count() +
2018-08-11 21:30:00 +02:00
theme_rsi()
# or better yet, simplify this using the wrapper function - a single command:
septic_patients \%>\%
2019-05-10 16:44:59 +02:00
select(AMX, NIT, FOS, TMP, CIP) \%>\%
2018-08-11 21:30:00 +02:00
ggplot_rsi()
2018-08-22 00:02:26 +02:00
2018-09-17 20:53:32 +02:00
# get only portions and no counts:
2018-08-22 00:02:26 +02:00
septic_patients \%>\%
2019-05-10 16:44:59 +02:00
select(AMX, NIT, FOS, TMP, CIP) \%>\%
2018-09-17 20:53:32 +02:00
ggplot_rsi(fun = portion_df)
# add other ggplot2 parameters as you like:
septic_patients \%>\%
2019-05-10 16:44:59 +02:00
select(AMX, NIT, FOS, TMP, CIP) \%>\%
ggplot_rsi(width = 0.5,
colour = "black",
size = 1,
linetype = 2,
alpha = 0.25)
2018-12-15 22:40:07 +01:00
# resistance of ciprofloxacine per age group
septic_patients \%>\%
mutate(first_isolate = first_isolate(.)) \%>\%
filter(first_isolate == TRUE,
mo == as.mo("E. coli")) \%>\%
# `age_group` is also a function of this package:
group_by(age_group = age_groups(age)) \%>\%
select(age_group,
2019-05-10 16:44:59 +02:00
CIP) \%>\%
2018-12-15 22:40:07 +01:00
ggplot_rsi(x = "age_group")
2018-08-13 16:42:37 +02:00
\donttest{
2018-08-29 16:39:28 +02:00
# for colourblind mode, use divergent colours from the viridis package:
septic_patients \%>\%
2019-05-10 16:44:59 +02:00
select(AMX, NIT, FOS, TMP, CIP) \%>\%
2018-08-29 16:39:28 +02:00
ggplot_rsi() + scale_fill_viridis_d()
2018-09-13 14:48:34 +02:00
# it also supports groups (don't forget to use the group var on `x` or `facet`):
2018-08-11 21:30:00 +02:00
septic_patients \%>\%
2019-05-10 16:44:59 +02:00
select(hospital_id, AMX, NIT, FOS, TMP, CIP) \%>\%
2018-08-13 16:42:37 +02:00
group_by(hospital_id) \%>\%
2018-09-13 14:48:34 +02:00
ggplot_rsi(x = hospital_id,
facet = Antibiotic,
2018-08-13 16:42:37 +02:00
nrow = 1) +
labs(title = "AMR of Anti-UTI Drugs Per Hospital",
x = "Hospital")
2018-08-13 16:42:37 +02:00
# genuine analysis: check 2 most prevalent microorganisms
septic_patients \%>\%
2018-08-13 16:42:37 +02:00
# create new bacterial ID's, with all CoNS under the same group (Becker et al.)
2018-08-31 13:36:19 +02:00
mutate(mo = as.mo(mo, Becker = TRUE)) \%>\%
2018-09-13 14:48:34 +02:00
# filter on top three bacterial ID's
filter(mo \%in\% top_freq(freq(.$mo), 3)) \%>\%
2018-08-13 16:42:37 +02:00
# determine first isolates
mutate(first_isolate = first_isolate(.,
col_date = "date",
col_patient_id = "patient_id",
2018-08-31 13:36:19 +02:00
col_mo = "mo")) \%>\%
2018-08-13 16:42:37 +02:00
# filter on first isolates
filter(first_isolate == TRUE) \%>\%
2018-09-13 14:48:34 +02:00
# get short MO names (like "E. coli")
mutate(mo = mo_shortname(mo, Becker = TRUE)) \%>\%
# select this short name and some antiseptic drugs
2019-05-10 16:44:59 +02:00
select(mo, CXM, GEN, CIP) \%>\%
2018-08-13 16:42:37 +02:00
# group by MO
group_by(mo) \%>\%
# plot the thing, putting MOs on the facet
2018-09-13 14:48:34 +02:00
ggplot_rsi(x = Antibiotic,
facet = mo,
translate_ab = FALSE,
nrow = 1) +
labs(title = "AMR of Top Three Microorganisms In Blood Culture Isolates",
2018-08-31 13:36:19 +02:00
subtitle = "Only First Isolates, CoNS grouped according to Becker et al. (2014)",
2018-08-13 16:42:37 +02:00
x = "Microorganisms")
}
2018-08-11 21:30:00 +02:00
}