Add rvar_col argument to all *.data.frame() methods

R/p_direction.R

@@ -67,7 +67,7 @@
 #'
 #' ## Methods of computation
 #' The *pd* is defined as:
 #' \deqn{p_d = max({Pr(\hat{\theta} < \theta_{null}), Pr(\hat{\theta} > \theta_{null})})}{pd = max(mean(x < null), mean(x > null))}
 #' \cr\cr
 #' The most simple and direct way to compute the *pd* is to compute the
 #' proportion of positive (or larger than `null`) posterior samples, the
@@ -89,7 +89,7 @@
 #'
 #' @seealso [pd_to_p()] to convert between Probability of Direction (pd) and p-value.
 #'
 #' @note There is also a [`plot()`-method](https://easystats.github.io/see/articles/bayestestR.html) implemented in the \href{https://easystats.github.io/see/}{\pkg{see}-package}.
 #'
 #' @references
 #' - Makowski, D., Ben-Shachar, M. S., Chen, S. A., & Lüdecke, D. (2019).
@@ -174,8 +174,26 @@
 
 
 #' @rdname p_direction
+#' @param rvar_col Name of an `rvar`-type column. If `NULL`, each column in the
+#'   data frame is assumed to represent draws from a posterior distribution.
 #' @export
-p_direction.data.frame <- function(x, method = "direct", null = 0, ...) {
+p_direction.data.frame <- function(x, method = "direct", null = 0, rvar_col = NULL, ...) {
+  if (is.null(rvar_col)) {
+    return(.p_direction_df(x, method = method, null = null, ...))
+  }
+
+  if (length(rvar_col) != 1L && !rvar_col %in% colnames(x)) {
+    insight::format_error("The `rvar_col` argument must be a single, valid column name.")
+  }
+
+  out <- p_direction(x[[rvar_col]], method = method, null = null, ...)
+  x[["pd"]] <- out[["pd"]]
+  x
+}
+
+
+#' @keywords internal
+.p_direction_df <- function(x, method = "direct", null = 0, ...) {
   obj_name <- insight::safe_deparse_symbol(substitute(x))
   x <- .select_nums(x)
 
@@ -352,7 +370,7 @@
 #' @export
 p_direction.stanreg <- function(x,
                                 effects = c("fixed", "random", "all"),
                                 component = c("location", "all", "conditional", "smooth_terms", "sigma", "distributional", "auxiliary"),
                                 parameters = NULL,
                                 method = "direct",
                                 null = 0,