AMR/R/proportion.R

288 lines
14 KiB
R
Raw Normal View History

2018-08-10 15:01:05 +02:00
# ==================================================================== #
# TITLE #
# Antimicrobial Resistance (AMR) Analysis #
# #
2019-01-02 23:24:07 +01:00
# SOURCE #
# https://gitlab.com/msberends/AMR #
2018-08-10 15:01:05 +02:00
# #
# LICENCE #
# (c) 2018-2020 Berends MS, Luz CF et al. #
2018-08-10 15:01:05 +02:00
# #
2019-01-02 23:24:07 +01:00
# This R package is free software; you can freely use and distribute #
# it for both personal and commercial purposes under the terms of the #
# GNU General Public License version 2.0 (GNU GPL-2), as published by #
# the Free Software Foundation. #
# #
# We created this package for both routine data analysis and academic #
# research and it was publicly released in the hope that it will be #
# useful, but it comes WITHOUT ANY WARRANTY OR LIABILITY. #
2019-04-05 18:47:39 +02:00
# Visit our website for more info: https://msberends.gitlab.io/AMR. #
2018-08-10 15:01:05 +02:00
# ==================================================================== #
#' Calculate microbial resistance
2018-08-10 15:01:05 +02:00
#'
#' @description These functions can be used to calculate the (co-)resistance or susceptibility of microbial isolates (i.e. percentage of S, SI, I, IR or R). All functions support quasiquotation with pipes, can be used in [dplyr::summarise()] and support grouped variables, please see *Examples*.
2018-08-10 15:01:05 +02:00
#'
#' [resistance()] should be used to calculate resistance, [susceptibility()] should be used to calculate susceptibility.\cr
#' @inheritSection lifecycle Stable lifecycle
#' @param ... one or more vectors (or columns) with antibiotic interpretations. They will be transformed internally with [as.rsi()] if needed. Use multiple columns to calculate (the lack of) co-resistance: the probability where one of two drugs have a resistant or susceptible result. See Examples.
#' @param minimum the minimum allowed number of available (tested) isolates. Any isolate count lower than `minimum` will return `NA` with a warning. The default number of `30` isolates is advised by the Clinical and Laboratory Standards Institute (CLSI) as best practice, see Source.
#' @param as_percent a logical to indicate whether the output must be returned as a hundred fold with % sign (a character). A value of `0.123456` will then be returned as `"12.3%"`.
#' @param only_all_tested (for combination therapies, i.e. using more than one variable for `...`): a logical to indicate that isolates must be tested for all antibiotics, see section *Combination therapy* below
#' @param data a [`data.frame`] containing columns with class [`rsi`] (see [as.rsi()])
#' @param translate_ab a column name of the [antibiotics] data set to translate the antibiotic abbreviations to, using [ab_property()]
2019-05-10 16:44:59 +02:00
#' @inheritParams ab_property
#' @param 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 `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 `TRUE`.
#' @param 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 `combine_SI`.
2019-11-29 19:43:23 +01:00
#' @inheritSection as.rsi Interpretation of R and S/I
#' @details
#' The function [resistance()] is equal to the function [proportion_R()]. The function [susceptibility()] is equal to the function [proportion_SI()].
#'
#' **Remember that you should filter your table to let it contain only first isolates!** This is needed to exclude duplicates and to reduce selection bias. Use [first_isolate()] to determine them in your data set.
2018-08-10 15:01:05 +02:00
#'
#' These functions are not meant to count isolates, but to calculate the proportion of resistance/susceptibility. Use the [AMR::count()] functions to count isolates. The function [susceptibility()] is essentially equal to `count_susceptible() / count_all()`. *Low counts can infuence the outcome - the `proportion` functions may camouflage this, since they only return the proportion (albeit being dependent on the `minimum` parameter).*
2018-08-22 00:02:26 +02:00
#'
#' The function [proportion_df()] takes any variable from `data` that has an [`rsi`] class (created with [as.rsi()]) and calculates the proportions R, I and S. The function [rsi_df()] works exactly like [proportion_df()], but adds the number of isolates.
#' @section Combination therapy:
#' When using more than one variable for `...` (= combination therapy)), use `only_all_tested` to only count isolates that are tested for all antibiotics/variables that you test them for. See this example for two antibiotics, Antibiotic A and Antibiotic B, about how [susceptibility()] works to calculate the %SI:
#'
#' ```
#' --------------------------------------------------------------------
#' only_all_tested = FALSE only_all_tested = TRUE
#' ----------------------- -----------------------
#' Drug A Drug B include as include as include as include as
#' numerator denominator numerator denominator
#' -------- -------- ---------- ----------- ---------- -----------
#' S or I S or I X X X X
#' R S or I X X X X
#' <NA> S or I X X - -
#' S or I R X X X X
#' R R - X - X
#' <NA> R - - - -
#' S or I <NA> X X - -
#' R <NA> - - - -
#' <NA> <NA> - - - -
#' --------------------------------------------------------------------
#' ```
2019-03-26 14:24:03 +01:00
#'
#' Please note that, in combination therapies, for `only_all_tested = TRUE` applies that:
#' ```
#' count_S() + count_I() + count_R() = count_all()
#' proportion_S() + proportion_I() + proportion_R() = 1
#' ```
#' and that, in combination therapies, for `only_all_tested = FALSE` applies that:
#' ```
#' count_S() + count_I() + count_R() >= count_all()
#' proportion_S() + proportion_I() + proportion_R() >= 1
#' ```
#'
#' Using `only_all_tested` has no impact when only using one antibiotic as input.
#' @source **M39 Analysis and Presentation of Cumulative Antimicrobial Susceptibility Test Data, 4th Edition**, 2014, *Clinical and Laboratory Standards Institute (CLSI)*. <https://clsi.org/standards/products/microbiology/documents/m39/>.
#' @seealso [AMR::count()] to count resistant and susceptible isolates.
#' @return A [`double`] or, when `as_percent = TRUE`, a [`character`].
#' @rdname proportion
#' @aliases portion
#' @name proportion
2018-08-10 15:01:05 +02:00
#' @export
2019-01-02 23:24:07 +01:00
#' @inheritSection AMR Read more on our website!
2018-08-10 15:01:05 +02:00
#' @examples
#' # example_isolates is a data set available in the AMR package.
#' ?example_isolates
#'
#' resistance(example_isolates$AMX) # determines %R
#' susceptibility(example_isolates$AMX) # determines %S+I
#'
#' # be more specific
#' proportion_S(example_isolates$AMX)
#' proportion_SI(example_isolates$AMX)
#' proportion_I(example_isolates$AMX)
#' proportion_IR(example_isolates$AMX)
#' proportion_R(example_isolates$AMX)
2018-08-10 15:01:05 +02:00
#'
#' library(dplyr)
#' example_isolates %>%
2018-08-10 15:01:05 +02:00
#' group_by(hospital_id) %>%
#' summarise(r = resistance(CIP),
#' n = n_rsi(CIP)) # n_rsi works like n_distinct in dplyr, see ?n_rsi
2018-08-10 15:01:05 +02:00
#'
#' example_isolates %>%
2018-08-10 15:01:05 +02:00
#' group_by(hospital_id) %>%
#' summarise(R = resistance(CIP, as_percent = TRUE),
#' SI = susceptibility(CIP, as_percent = TRUE),
2019-05-10 16:44:59 +02:00
#' n1 = count_all(CIP), # the actual total; sum of all three
#' n2 = n_rsi(CIP), # same - analogous to n_distinct
2019-03-26 14:24:03 +01:00
#' total = n()) # NOT the number of tested isolates!
2018-08-10 15:01:05 +02:00
#'
#' # Calculate co-resistance between amoxicillin/clav acid and gentamicin,
#' # so we can see that combination therapy does a lot more than mono therapy:
#' example_isolates %>% susceptibility(AMC) # %SI = 76.3%
#' example_isolates %>% count_all(AMC) # n = 1879
#'
#' example_isolates %>% susceptibility(GEN) # %SI = 75.4%
#' example_isolates %>% count_all(GEN) # n = 1855
2018-08-10 15:01:05 +02:00
#'
#' example_isolates %>% susceptibility(AMC, GEN) # %SI = 94.1%
#' example_isolates %>% count_all(AMC, GEN) # n = 1939
2018-08-23 00:40:36 +02:00
#'
2018-08-10 15:01:05 +02:00
#'
#' # See Details on how `only_all_tested` works. Example:
#' example_isolates %>%
#' summarise(numerator = count_susceptible(AMC, GEN),
#' denominator = count_all(AMC, GEN),
#' proportion = susceptibility(AMC, GEN))
#' example_isolates %>%
#' summarise(numerator = count_susceptible(AMC, GEN, only_all_tested = TRUE),
#' denominator = count_all(AMC, GEN, only_all_tested = TRUE),
#' proportion = susceptibility(AMC, GEN, only_all_tested = TRUE))
2019-06-27 11:57:45 +02:00
#'
2018-08-10 15:01:05 +02:00
#'
#' example_isolates %>%
2018-08-10 15:01:05 +02:00
#' group_by(hospital_id) %>%
#' summarise(cipro_p = susceptibility(CIP, as_percent = TRUE),
2019-05-10 16:44:59 +02:00
#' cipro_n = count_all(CIP),
#' genta_p = susceptibility(GEN, as_percent = TRUE),
2019-05-10 16:44:59 +02:00
#' genta_n = count_all(GEN),
#' combination_p = susceptibility(CIP, GEN, as_percent = TRUE),
2019-05-10 16:44:59 +02:00
#' combination_n = count_all(CIP, GEN))
2018-08-10 15:01:05 +02:00
#'
#' # Get proportions S/I/R immediately of all rsi columns
#' example_isolates %>%
2019-05-10 16:44:59 +02:00
#' select(AMX, CIP) %>%
#' proportion_df(translate = FALSE)
#'
#' # It also supports grouping variables
#' example_isolates %>%
2019-05-10 16:44:59 +02:00
#' select(hospital_id, AMX, CIP) %>%
#' group_by(hospital_id) %>%
#' proportion_df(translate = FALSE)
#'
#'
2018-08-10 15:01:05 +02:00
#' \dontrun{
#'
#' # calculate current empiric combination therapy of Helicobacter gastritis:
#' my_table %>%
#' filter(first_isolate == TRUE,
#' genus == "Helicobacter") %>%
#' summarise(p = susceptibility(AMX, MTR), # amoxicillin with metronidazole
2019-05-10 16:44:59 +02:00
#' n = count_all(AMX, MTR))
2018-08-10 15:01:05 +02:00
#' }
resistance <- function(...,
minimum = 30,
as_percent = FALSE,
only_all_tested = FALSE) {
2018-08-23 00:40:36 +02:00
rsi_calc(...,
ab_result = "R",
2018-08-10 15:01:05 +02:00
minimum = minimum,
2018-08-22 00:02:26 +02:00
as_percent = as_percent,
only_all_tested = only_all_tested,
2018-08-22 00:02:26 +02:00
only_count = FALSE)
2018-08-10 15:01:05 +02:00
}
#' @rdname proportion
2018-08-10 15:01:05 +02:00
#' @export
susceptibility <- function(...,
minimum = 30,
as_percent = FALSE,
only_all_tested = FALSE) {
rsi_calc(...,
ab_result = c("S", "I"),
minimum = minimum,
as_percent = as_percent,
only_all_tested = only_all_tested,
only_count = FALSE)
}
#' @rdname proportion
#' @export
proportion_R <- function(...,
minimum = 30,
as_percent = FALSE,
only_all_tested = FALSE) {
rsi_calc(...,
ab_result = "R",
minimum = minimum,
as_percent = as_percent,
only_all_tested = only_all_tested,
only_count = FALSE)
}
#' @rdname proportion
#' @export
proportion_IR <- function(...,
minimum = 30,
as_percent = FALSE,
only_all_tested = FALSE) {
2018-08-23 00:40:36 +02:00
rsi_calc(...,
ab_result = c("I", "R"),
2018-08-10 15:01:05 +02:00
minimum = minimum,
2018-08-22 00:02:26 +02:00
as_percent = as_percent,
only_all_tested = only_all_tested,
2018-08-22 00:02:26 +02:00
only_count = FALSE)
2018-08-10 15:01:05 +02:00
}
#' @rdname proportion
2018-08-10 15:01:05 +02:00
#' @export
proportion_I <- function(...,
minimum = 30,
as_percent = FALSE,
only_all_tested = FALSE) {
2018-08-23 00:40:36 +02:00
rsi_calc(...,
ab_result = "I",
2018-08-10 15:01:05 +02:00
minimum = minimum,
2018-08-22 00:02:26 +02:00
as_percent = as_percent,
only_all_tested = only_all_tested,
2018-08-22 00:02:26 +02:00
only_count = FALSE)
2018-08-10 15:01:05 +02:00
}
#' @rdname proportion
2018-08-10 15:01:05 +02:00
#' @export
proportion_SI <- function(...,
minimum = 30,
as_percent = FALSE,
only_all_tested = FALSE) {
2018-08-23 00:40:36 +02:00
rsi_calc(...,
ab_result = c("S", "I"),
2018-08-10 15:01:05 +02:00
minimum = minimum,
2018-08-22 00:02:26 +02:00
as_percent = as_percent,
only_all_tested = only_all_tested,
2018-08-22 00:02:26 +02:00
only_count = FALSE)
2018-08-10 15:01:05 +02:00
}
#' @rdname proportion
2018-08-10 15:01:05 +02:00
#' @export
proportion_S <- function(...,
minimum = 30,
as_percent = FALSE,
only_all_tested = FALSE) {
2018-08-23 00:40:36 +02:00
rsi_calc(...,
ab_result = "S",
2018-08-10 15:01:05 +02:00
minimum = minimum,
2018-08-22 00:02:26 +02:00
as_percent = as_percent,
only_all_tested = only_all_tested,
2018-08-22 00:02:26 +02:00
only_count = FALSE)
2018-08-10 15:01:05 +02:00
}
#' @rdname proportion
2018-08-22 00:02:26 +02:00
#' @importFrom dplyr %>% select_if bind_rows summarise_if mutate group_vars select everything
2018-08-12 17:44:06 +02:00
#' @export
proportion_df <- function(data,
translate_ab = "name",
language = get_locale(),
minimum = 30,
as_percent = FALSE,
combine_SI = TRUE,
combine_IR = FALSE) {
rsi_calc_df(type = "proportion",
2019-05-13 10:10:16 +02:00
data = data,
translate_ab = translate_ab,
language = language,
minimum = minimum,
as_percent = as_percent,
combine_SI = combine_SI,
combine_IR = combine_IR,
combine_SI_missing = missing(combine_SI))
2018-08-12 17:44:06 +02:00
}