Merge pull request #367 from stan-dev/ppc_error_scatter_avg

combining ppc_error_scatter_avg_vs_x with ppc_error_scatter_avg(x = x)

Author: TeemuSailynoja

NEWS.md

@@ -4,6 +4,7 @@
 * `ppc_error_scatter_avg_vs_x(x = some_expression)` labels the *x* axis with `some_expression`.
 * Add `ppc_dots()` and `ppd_dots()` by @behramulukir (#357)
 * Add `x` argument to `ppc_error_binned` by @behramulukir (#359)
+* Add `x` argument to `ppc_error_scatter_avg()` by @behramulukir (#367)
 
 # bayesplot 1.13.0
 

R/ppc-errors.R

@@ -54,10 +54,12 @@
 #'    `y` and each dataset (row) in `yrep`. For each individual data point
 #'    `y[n]` the average error is the average of the errors for `y[n]` computed
 #'    over the the draws from the posterior predictive distribution.
+#'
+#'    When the optional `x` argument is provided, the average error is plotted
+#'    on the y-axis and the predictor variable `x` is plotted on the x-axis.
 #'   }
 #'   \item{`ppc_error_scatter_avg_vs_x()`}{
-#'    Same as `ppc_error_scatter_avg()`, except the average is plotted on the
-#'    y-axis and a predictor variable `x` is plotted on the x-axis.
+#'    Deprecated. Use `ppc_error_scatter_avg(x = x)` instead.
 #'   }
 #'   \item{`ppc_error_binned()`}{
 #'    Intended for use with binomial data. A separate binned error plot (similar
@@ -92,7 +94,7 @@
 #' ppc_error_scatter_avg(y, yrep)
 #'
 #' x <- example_x_data()
-#' ppc_error_scatter_avg_vs_x(y, yrep, x)
+#' ppc_error_scatter_avg(y, yrep, x)
 #'
 #' \dontrun{
 #' # binned error plot with binomial model from rstanarm
@@ -217,6 +219,7 @@ ppc_error_scatter <-
 ppc_error_scatter_avg <-
   function(y,
            yrep,
+           x = NULL,
            ...,
            stat = "mean",
            size = 2.5,
@@ -225,19 +228,31 @@ ppc_error_scatter_avg <-
 
     y <- validate_y(y)
     yrep <- validate_predictions(yrep, length(y))
+
+    if (!missing(x)) {
+      qx <- enquo(x)
+      x <- validate_x(x, y)
+    }
     errors <- compute_errors(y, yrep)
 
     stat <- as_tagged_function({{ stat }})
 
     ppc_scatter_avg(
-      y = y,
+      y = if (is_null(x)) y else x,
       yrep = errors,
       size = size,
       alpha = alpha,
       ref_line = FALSE,
       stat = stat
     ) +
-      labs(x = error_avg_label(stat), y = y_label())
+      labs(
+        x = error_avg_label(stat),
+        y = if (is_null(x)) y_label() else as_label((qx))
+        ) + if (is_null(x)) {
+          NULL
+        } else {
+          coord_flip()
+        }
   }
 
 
@@ -286,6 +301,8 @@ ppc_error_scatter_avg_vs_x <- function(
 ) {
   check_ignored_arguments(...)
 
+  .Deprecated(new = "ppc_error_scatter_avg(y, yrep, x)")
+
   y <- validate_y(y)
   yrep <- validate_predictions(yrep, length(y))
   qx <- enquo(x)