docs

Author: strengejacke

DESCRIPTION

@@ -1,7 +1,7 @@
 Type: Package
 Package: performance
 Title: Assessment of Regression Models Performance
-Version: 0.17.0.5
+Version: 0.17.0.6
 Authors@R:
     c(person(given = "Daniel",
              family = "Lüdecke",

R/check_priors.R

@@ -47,8 +47,19 @@
 #'
 #' @examples
 #' \dontrun{
+#' # model with correctly defined priors. outcome is binary, prior
+#' # predictive checks indicate the predicted probability mass based
+#' # on the prior distributions - the resulting pattern aligns with
+#' # our real-world assumptions
 #' model <- insight::download_model("stan_prior_checks_1")
 #' plot(check_priors(model, "mmse"))
+#'
+#' # model with default (weakly informative) priors, which is poorly
+#' # calibrated. It pushes probability mass almost exclusively to the
+#' # extremes of 0 and 1, leaving the plausible middle range largely
+#' # unsupported
+#' model <- insight::download_model("stan_prior_checks_2")
+#' plot(check_priors(model, "mmse"))
 #' }
 #' @export
 check_priors <- function(model = NULL, ...) {