From 838d427278a4360740e0ada9fcec2d758f825848 Mon Sep 17 00:00:00 2001 From: Dominique Makowski Date: Sun, 30 Jul 2023 18:23:50 +0100 Subject: [PATCH] minor --- R/p_direction.R | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/R/p_direction.R b/R/p_direction.R index cfcad25c5..288e773c7 100644 --- a/R/p_direction.R +++ b/R/p_direction.R @@ -17,11 +17,15 @@ #' #' @details #' ## What is the *pd*? -#' The Probability of Direction (pd) is an index of effect existence, ranging -#' from 0 to 1, representing the certainty with which an effect goes in a -#' particular direction (*i.e.*, is positive or negative / has a sign). Beyond +#' The Probability of Direction (pd) is an index of effect existence, representing +#' the certainty with which an effect goes in a particular direction (i.e., is +#' positive or negative / has a sign), typically ranging from 0.5 to 1 (but see +#' next section for cases where it can range between 0 and 1). Beyond #' its simplicity of interpretation, understanding and computation, this index #' also presents other interesting properties: +#' - Like other posterior-based indices, *pd* is solely based on the posterior +#' distributions and does not require any additional information from the data +#' or the model (e.g., such as priors, as in the case of Bayes factors). #' - It is robust to the scale of both the response variable and the predictors. #' - It is strongly correlated with the frequentist p-value, and can thus #' be used to draw parallels and give some reference to readers non-familiar