diff --git a/R/check_predictions.R b/R/check_predictions.R index b39cd6458..8ce1edd0c 100644 --- a/R/check_predictions.R +++ b/R/check_predictions.R @@ -11,6 +11,9 @@ #' of frequentist models (e.g., `lm`, `merMod`, `glmmTMB`, ...). For Bayesian #' models, the model is passed to [`bayesplot::pp_check()`]. #' +#' If `check_model()` doesn't work as expected, try setting `verbose = TRUE` +#' to get hints about possible problems. +#' #' @param object A statistical model. #' @param iterations The number of draws to simulate/bootstrap. #' @param check_range Logical, if `TRUE`, includes a plot with the minimum @@ -53,6 +56,9 @@ #' package that imports **bayesplot** such as **rstanarm** or **brms**) #' is loaded, `pp_check()` is also available as an alias for `check_predictions()`. #' +#' If `check_model()` doesn't work as expected, try setting `verbose = TRUE` to +#' get hints about possible problems. +#' #' @family functions to check model assumptions and and assess model quality #' #' @references diff --git a/man/check_predictions.Rd b/man/check_predictions.Rd index 6c13fc0d5..c4882ca0c 100644 --- a/man/check_predictions.Rd +++ b/man/check_predictions.Rd @@ -63,6 +63,9 @@ simulated data" (\emph{Gelman et al. 2014, p. 169}). \strong{performance} provides posterior predictive check methods for a variety of frequentist models (e.g., \code{lm}, \code{merMod}, \code{glmmTMB}, ...). For Bayesian models, the model is passed to \code{\link[bayesplot:pp_check]{bayesplot::pp_check()}}. + +If \code{check_model()} doesn't work as expected, try setting \code{verbose = TRUE} +to get hints about possible problems. } \details{ An example how posterior predictive checks can also be used for model @@ -78,6 +81,9 @@ Every model object that has a \code{simulate()}-method should work with \code{check_predictions()}. On R 3.6.0 and higher, if \strong{bayesplot} (or a package that imports \strong{bayesplot} such as \strong{rstanarm} or \strong{brms}) is loaded, \code{pp_check()} is also available as an alias for \code{check_predictions()}. + +If \code{check_model()} doesn't work as expected, try setting \code{verbose = TRUE} to +get hints about possible problems. } \examples{ \dontshow{if (require("see")) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf}