add vertical, horizontal line, text label to 2d performance plot

R/perf_plot_spec.R

@@ -17,6 +17,9 @@ new_PerfPlotSpec <- function(
     smooth_benchmark,
     scale_x,
     scale_y,
+    hline,
+    vline,
+    text,
     alpha,
     colors,
     width,
@@ -40,6 +43,9 @@ new_PerfPlotSpec <- function(
     stopifnot(is.character(smooth_method) || is.null(smooth_method) ||
         is.function(smooth_method))
     stopifnot(is.logical(smooth_benchmark))
+    stopifnot(is.null(hline) || is.list(hline))
+    stopifnot(is.null(vline) || is.list(vline))
+    stopifnot(is.null(text) || is.list(text))
     stopifnot(is.numeric(alpha) && alpha >= 0 && alpha <= 1)
     stopifnot(is.character(colors) || is.null(colors))
     stopifnot(is.numeric(width) && width > 0)
@@ -65,6 +71,9 @@ new_PerfPlotSpec <- function(
         "smooth_benchmark" = smooth_benchmark,
         "scale_x" = scale_x,
         "scale_y" = scale_y,
+        "hline" = hline,
+        "vline" = vline,
+        "text" = text,
         "alpha" = alpha,
         "colors" = colors,
         "width" = width,
@@ -116,6 +125,11 @@ new_PerfPlotSpec <- function(
 #' @param scale_x,scale_y string or transformation object (see [`scales::trans_new`] for the 
 #' latter). The scale of the axes, we will pass them to the `x` and `y` parameter of 
 #' [`ggplot2::coord_trans()`], respectively. Default is `"identity"`.
+#' @param vline,hline list or NULL. Vertical/horizontal lines to be added to the plot. A list
+#' holding the arguments to pass to [`ggplot2::geom_vline()`] and [`ggplot2::geom_hline()`],
+#' respectively. Default is `NULL`.
+#' @param text list or NULL. Text label added to the plot. A list holding the arguments to
+#' pass to [`ggplot2::geom_text()`]. Default is `NULL`. 
 #' @param alpha numeric in \[0, 1\]. The alpha value for the points and lines in the 
 #' plot.
 #' @param width numeric. The width of the plot in `units`. Default is `7`.
@@ -144,6 +158,9 @@ PerfPlotSpec <- function(
     smooth_benchmark = FALSE,
     scale_x = "identity",
     scale_y = "identity",
+    vline = NULL,
+    hline = NULL,
+    text = NULL,
     alpha = 0.5,
     width = 7,
     height = 4,
@@ -177,6 +194,9 @@ PerfPlotSpec <- function(
         smooth_benchmark = smooth_benchmark,
         scale_x = scale_x,
         scale_y = scale_y,
+        vline = vline,
+        hline = hline,
+        text = text,
         alpha = alpha,
         width = width,
         height = height,

R/plot.R

@@ -37,10 +37,14 @@ plot_2d_metric <- function(
             x = perf_plot_spec$x_lab, 
             y = perf_plot_spec$y_lab
         ) +
-        ggplot2::coord_trans(
-            x = perf_plot_spec$scale_x, 
-            y = perf_plot_spec$scale_y
-        )
+        ggplot2::scale_x_continuous(trans = perf_plot_spec$scale_x) + 
+        ggplot2::scale_y_continuous(trans = perf_plot_spec$scale_y)
+    if(!is.null(perf_plot_spec$hline))
+        plt <- plt + do.call(ggplot2::geom_hline, perf_plot_spec$hline)
+    if(!is.null(perf_plot_spec$vline))
+        plt <- plt + do.call(ggplot2::geom_vline, perf_plot_spec$vline)
+    if(!is.null(perf_plot_spec$text))
+        plt <- plt + do.call(ggplot2::geom_text, perf_plot_spec$text)
     if(!is.null(perf_plot_spec$benchmark) && !is.null(bm_data)){
         bm_alpha <- ifelse(
             perf_plot_spec$smooth_benchmark, 

tests/testthat/test-assess_model.R

@@ -51,7 +51,9 @@ test_that("assess_model() works", {
     y_metric = "prec",
     pivot_time_cutoff = 2.,
     benchmark = "ipi",
-    show_plots = TRUE
+    show_plots = FALSE,
+    text = list(ggplot2::aes(x = .5, y = .5, label = "this text"), 
+      color = "red", angle = 45)
   )
 
   for(model_spec in list(model_spec_1, model_spec_2)){

tests/testthat/test-plot.R

@@ -12,14 +12,16 @@ test_that("plot_2d_metric() works", {
     y_metric = "prec",
     pivot_time_cutoff = 2.,
     benchmark = "bm",
-    show_plots = FALSE,
+    show_plots = TRUE,
     title = "this title",
     x_lab = "this x lab",
     y_lab = "that y lab",
     xlim = c(0, .9),
     smooth_method = "loess",
     smooth_benchmark = TRUE,
-    scale_x = "log10"
+    scale_x = "log10",
+    hline = list(yintercept = 0.5, linetype = "dashed"),
+    text = list(ggplot2::aes(x = 0.5, y = 0.5, label = "this text"))
   )
   perf_plot_spec$data <- tibble::tibble(
     rpp = runif(n_row),
@@ -34,6 +36,9 @@ test_that("plot_2d_metric() works", {
     )
   )
   perf_plot_spec$benchmark <- NULL
+  perf_plot_spec$hline <- NULL
+  perf_plot_spec$text <- NULL
+  perf_plot_spec$vline <- list(xintercept = 0.5, color = "blue")
   expect_no_error(
     plot_2d_metric(
       perf_plot_spec = perf_plot_spec,