From 880c3efc19715f2ac1d48a22b9bfa2105effdf77 Mon Sep 17 00:00:00 2001 From: Daniel Date: Wed, 20 Mar 2024 18:23:59 +0100 Subject: [PATCH] docs, typo --- R/check_model.R | 13 +++++++------ R/check_zeroinflation.R | 2 +- man/check_model.Rd | 13 +++++++------ man/check_overdispersion.Rd | 2 +- man/check_zeroinflation.Rd | 2 +- 5 files changed, 17 insertions(+), 15 deletions(-) diff --git a/R/check_model.R b/R/check_model.R index f75a103a8..cf33f3eef 100644 --- a/R/check_model.R +++ b/R/check_model.R @@ -144,12 +144,13 @@ #' inside the error bounds. See [`binned_residuals()`] for further details. #' #' @section Residuals for (Generalized) Linear Models: -#' Plots that check the normality of residuals (Q-Q plot) or the homogeneity of -#' variance use standardized Pearson's residuals for generalized linear models, -#' and standardized residuals for linear models. The plots for the normality of -#' residuals (with overlayed normal curve) and for the linearity assumption use -#' the default residuals for `lm` and `glm` (which are deviance residuals for -#' `glm`). +#' Plots that check the homogeneity of variance use standardized Pearson's +#' residuals for generalized linear models, and standardized residuals for +#' linear models. The plots for the normality of residuals (with overlayed +#' normal curve) and for the linearity assumption use the default residuals +#' for `lm` and `glm` (which are deviance residuals for `glm`). The Q-Q plots +#' use simulated residuals (see [`simulate_residuals()`]) for non-Gaussian +#' models and standardized residuals for linear models. #' #' @section Troubleshooting: #' For models with many observations, or for more complex models in general, diff --git a/R/check_zeroinflation.R b/R/check_zeroinflation.R index aaa5e7641..170c0d302 100644 --- a/R/check_zeroinflation.R +++ b/R/check_zeroinflation.R @@ -30,7 +30,7 @@ #' #' @section Tests based on simulated residuals: #' For certain models, resp. model from certain families, tests are based on -#' simulated residuals (see [`simulated_residual()`]). These are usually more +#' simulated residuals (see [`simulate_residual()`]). These are usually more #' accurate for testing such models than the traditionally used Pearson residuals. #' However, when simulating from more complex models, such as mixed models or #' models with zero-inflation, there are several important considerations. diff --git a/man/check_model.Rd b/man/check_model.Rd index 4bdea6ebe..d0d7e765b 100644 --- a/man/check_model.Rd +++ b/man/check_model.Rd @@ -212,12 +212,13 @@ inside the error bounds. See \code{\link[=binned_residuals]{binned_residuals()}} \section{Residuals for (Generalized) Linear Models}{ -Plots that check the normality of residuals (Q-Q plot) or the homogeneity of -variance use standardized Pearson's residuals for generalized linear models, -and standardized residuals for linear models. The plots for the normality of -residuals (with overlayed normal curve) and for the linearity assumption use -the default residuals for \code{lm} and \code{glm} (which are deviance residuals for -\code{glm}). +Plots that check the homogeneity of variance use standardized Pearson's +residuals for generalized linear models, and standardized residuals for +linear models. The plots for the normality of residuals (with overlayed +normal curve) and for the linearity assumption use the default residuals +for \code{lm} and \code{glm} (which are deviance residuals for \code{glm}). The Q-Q plots +use simulated residuals (see \code{\link[=simulate_residuals]{simulate_residuals()}}) for non-Gaussian +models and standardized residuals for linear models. } \section{Troubleshooting}{ diff --git a/man/check_overdispersion.Rd b/man/check_overdispersion.Rd index 8586e7833..5d89e6735 100644 --- a/man/check_overdispersion.Rd +++ b/man/check_overdispersion.Rd @@ -79,7 +79,7 @@ negative binomial, see \emph{Gelman and Hill (2007), pages 115-116}). \section{Tests based on simulated residuals}{ For certain models, resp. model from certain families, tests are based on -simulated residuals (see \code{\link[=simulated_residual]{simulated_residual()}}). These are usually more +simulated residuals (see \code{\link[=simulate_residual]{simulate_residual()}}). These are usually more accurate for testing such models than the traditionally used Pearson residuals. However, when simulating from more complex models, such as mixed models or models with zero-inflation, there are several important considerations. diff --git a/man/check_zeroinflation.Rd b/man/check_zeroinflation.Rd index a4ddc7135..51b353e80 100644 --- a/man/check_zeroinflation.Rd +++ b/man/check_zeroinflation.Rd @@ -54,7 +54,7 @@ is internally called if necessary. \section{Tests based on simulated residuals}{ For certain models, resp. model from certain families, tests are based on -simulated residuals (see \code{\link[=simulated_residual]{simulated_residual()}}). These are usually more +simulated residuals (see \code{\link[=simulate_residual]{simulate_residual()}}). These are usually more accurate for testing such models than the traditionally used Pearson residuals. However, when simulating from more complex models, such as mixed models or models with zero-inflation, there are several important considerations.