Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
strengejacke committed Nov 22, 2024
1 parent 5a48ab5 commit 71ca921
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 9 deletions.
7 changes: 6 additions & 1 deletion R/check_model.R
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,13 @@
#' @name check_model
#'
#' @description
#'
#' Visual check of various model assumptions (normality of residuals, normality
#' of random effects, linear relationship, homogeneity of variance,
#' multicollinearity).
#'
#' If `check_model()` doesn't work as expected, try setting `verbose = TRUE` to
#' get hints about possible problems.
#'
#' @param x A model object.
#' @param dot_size,line_size Size of line and dot-geoms.
#' @param base_size,title_size,axis_title_size Base font size for axis and plot titles.
Expand Down Expand Up @@ -161,6 +163,9 @@
#' look at the `check` argument and see if some of the model checks could be
#' skipped, which also increases performance.
#'
#' 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
#'
#' @examplesIf require("lme4")
Expand Down
8 changes: 4 additions & 4 deletions R/check_predictions.R
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@
#' 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.
#' If `check_predictions()` 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.
Expand Down Expand Up @@ -56,8 +56,8 @@
#' 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.
#' If `check_predictions()` 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
#'
Expand Down
6 changes: 6 additions & 0 deletions man/check_model.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 4 additions & 4 deletions man/check_predictions.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 71ca921

Please sign in to comment.