Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
strengejacke committed Mar 16, 2024
1 parent 42d20d9 commit 22cb2a6
Show file tree
Hide file tree
Showing 6 changed files with 42 additions and 24 deletions.
11 changes: 7 additions & 4 deletions R/check_zeroinflation.R
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,13 @@
#' complex model, such as mixed models or models with zero-inflation, there are
#' several important considerations. Arguments specified in `...` are passed to
#' [`simulate_residuals()`], which relies on [`DHARMa::simulateResiduals()`] (and
#' therefore, arguments in `...` are passed further down to _DHARMa_). It is
#' recommended to read the 'Details' in `?DHARMa::simulateResiduals` closely to
#' understand the implications of the simulation process and which arguments
#' should be modified to get the most accurate results.
#' therefore, arguments in `...` are passed further down to _DHARMa_). The
#' defaults in DHARMa are set on the most conservative option that works for
#' all models. However, in many cases, the help advises to use different settings
#' in particular situations or for particular models. It is recommended to read
#' the 'Details' in `?DHARMa::simulateResiduals` closely to understand the
#' implications of the simulation process and which arguments should be modified
#' to get the most accurate results.
#'
#' @family functions to check model assumptions and and assess model quality
#'
Expand Down
11 changes: 7 additions & 4 deletions R/simulate_residuals.R
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,13 @@
#' complex model, such as mixed models or models with zero-inflation, there are
#' several important considerations. `simulate_residuals()` relies on
#' [`DHARMa::simulateResiduals()`], and additional arguments specified in `...`
#' are passed further down to that function. It is recommended to read the
#' 'Details' in `?DHARMa::simulateResiduals` closely to understand the
#' implications of the simulation process and which arguments should be modified
#' to get the most accurate results.
#' are passed further down to that function. The defaults in DHARMa are set on
#' the most conservative option that works for all models. However, in many
#' cases, the help advises to use different settings in particular situations
#' or for particular models. It is recommended to read the 'Details' in
#' `?DHARMa::simulateResiduals` closely to understand the implications of the
#' simulation process and which arguments should be modified to get the most
#' accurate results.
#'
#' @references
#'
Expand Down
11 changes: 7 additions & 4 deletions man/check_overdispersion.Rd

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

11 changes: 7 additions & 4 deletions man/check_residuals.Rd

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

11 changes: 7 additions & 4 deletions man/check_zeroinflation.Rd

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

11 changes: 7 additions & 4 deletions man/simulate_residuals.Rd

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

0 comments on commit 22cb2a6

Please sign in to comment.