v3.0.1

R/plotting.R

@@ -52,11 +52,19 @@
 #' @details
 #' ### The `scale_*_mic()` Functions
 #'
-#' The functions [scale_x_mic()], [scale_y_mic()], [scale_colour_mic()], and [scale_fill_mic()] functions allow to plot the [mic][as.mic()] class (MIC values) on a continuous, logarithmic scale. They also allow to rescale the MIC range with an 'inside' or 'outside' range if required, and retain the operators in MIC values (such as `>=`) if desired. Missing intermediate log2 levels will be plotted too.
+#' The functions [scale_x_mic()], [scale_y_mic()], [scale_colour_mic()], and [scale_fill_mic()] functions allow to plot the [mic][as.mic()] class (MIC values) on a continuous, logarithmic scale.
+#' 
+#' There is normally no need to add these scale functions to your plot, as they are applied automatically when plotting values of class [mic][as.mic()].
+#' 
+#' When manually added though, they allow to rescale the MIC range with an 'inside' or 'outside' range if required, and provide the option to retain the operators in MIC values (such as `>=`). Missing intermediate log2 levels will always be plotted too.
 #'
 #' ### The `scale_*_sir()` Functions
 #'
-#' The functions [scale_x_sir()], [scale_colour_sir()], and [scale_fill_sir()] functions allow to plot the [sir][as.sir()] class in the right order (`r paste(levels(NA_sir_), collapse = " < ")`). At default, they translate the S/I/R values to an interpretative text ("Susceptible", "Resistant", etc.) in any of the `r length(AMR:::LANGUAGES_SUPPORTED)` supported languages (use `language = NULL` to keep S/I/R). Also, except for [scale_x_sir()], they set colour-blind friendly colours to the `colour` and `fill` aesthetics.
+#' The functions [scale_x_sir()], [scale_colour_sir()], and [scale_fill_sir()] functions allow to plot the [sir][as.sir()] class in the right order (`r paste(levels(NA_sir_), collapse = " < ")`).
+#' 
+#' There is normally no need to add these scale functions to your plot, as they are applied automatically when plotting values of class [sir][as.sir()].
+#' 
+#' At default, they translate the S/I/R values to an interpretative text ("Susceptible", "Resistant", etc.) in any of the `r length(AMR:::LANGUAGES_SUPPORTED)` supported languages (use `language = NULL` to keep S/I/R). Also, except for [scale_x_sir()], they set colour-blind friendly colours to the `colour` and `fill` aesthetics.
 #'
 #' ### Additional `ggplot2` Functions
 #'
@@ -114,17 +122,12 @@
 #'   ) +
 #'     geom_col()
 #'   mic_plot +
-#'     labs(title = "without scale_x_mic()")
+#'     labs(title = "scale_x_mic() automatically applied")
 #' }
 #' 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")
+#'     scale_x_mic(keep_operators = "none") +
+#'     labs(title = "with scale_x_mic() keeping no operators")
 #' }
 #' if (require("ggplot2")) {
 #'   mic_plot +
@@ -151,7 +154,7 @@
 #'   ) +
 #'     geom_boxplot() +
 #'     geom_violin(linetype = 2, colour = "grey30", fill = NA) +
-#'     scale_y_mic()
+#'     labs(title = "scale_y_mic() automatically applied")
 #' }
 #' if (require("ggplot2")) {
 #'   ggplot(
@@ -183,7 +186,7 @@
 #'
 #' # Plotting using scale_y_mic() and scale_colour_sir() ------------------
 #' if (require("ggplot2")) {
-#'   plain <- ggplot(
+#'   mic_sir_plot <- ggplot(
 #'     data.frame(
 #'       mic = some_mic_values,
 #'       group = some_groups,
@@ -197,21 +200,16 @@
 #'     theme_minimal() +
 #'     geom_boxplot(fill = NA, colour = "grey30") +
 #'     geom_jitter(width = 0.25)
-#'
-#'   plain
+#'     labs(title = "scale_y_mic()/scale_colour_sir() automatically applied")
+#'     
+#'   mic_sir_plot
 #' }
 #' if (require("ggplot2")) {
-#'   # and now with our MIC and SIR scale functions:
-#'   plain +
-#'     scale_y_mic() +
-#'     scale_colour_sir()
-#' }
-#' if (require("ggplot2")) {
-#'   plain +
+#'   mic_sir_plot +
 #'     scale_y_mic(mic_range = c(0.005, 32), name = "Our MICs!") +
 #'     scale_colour_sir(
-#'       language = "pt",
-#'       name = "Support in 27 languages"
+#'       language = "pt", # Portuguese
+#'       name = "Support in 28 languages"
 #'     )
 #' }
 #' }
@@ -229,6 +227,9 @@
 #' plot(some_sir_values)
 NULL
 
+#' @rawNamespace if(getRversion() >= "3.0.0") S3method(ggplot2::scale_type, mic)
+scale_type.mic <- function(x) c("mic", "discrete")
+
 create_scale_mic <- function(aest, keep_operators, mic_range = NULL, ...) {
   ggplot_fn <- getExportedValue(paste0("scale_", aest, "_continuous"),
     ns = asNamespace("ggplot2")
@@ -381,6 +382,9 @@ scale_fill_mic <- function(keep_operators = "edges", mic_range = NULL, ...) {
   create_scale_mic("fill", keep_operators = keep_operators, mic_range = mic_range, ...)
 }
 
+#' @rawNamespace if(getRversion() >= "3.0.0") S3method(ggplot2::scale_type, sir)
+scale_type.sir <- function(x) c("sir", "discrete")
+
 create_scale_sir <- function(aesthetics, colours_SIR, language, eucast_I, ...) {
   args <- list(...)
   args[c("value", "labels", "limits")] <- NULL