diff --git a/NEWS.md b/NEWS.md index 9f1572292..805cb0dbd 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,5 +1,7 @@ # performance 0.11.1 +* Improved documentation and new vignettes added. + * `check_model()` gets a `base_size` argument, to set the base font size for plots. # performance 0.11.0 diff --git a/R/check_collinearity.R b/R/check_collinearity.R index 8aac2c9d6..14dd2fcce 100644 --- a/R/check_collinearity.R +++ b/R/check_collinearity.R @@ -31,6 +31,8 @@ #' with other terms, and tolerance values (including confidence intervals), #' where `tolerance = 1/vif`. #' +#' @seealso [`see::plot.see_check_collinearity()`] for options to customize the plot. +#' #' @section Multicollinearity: #' Multicollinearity should not be confused with a raw strong correlation #' between predictors. What matters is the association between one or more diff --git a/R/check_normality.R b/R/check_normality.R index 3c2902915..297c50179 100644 --- a/R/check_normality.R +++ b/R/check_normality.R @@ -17,6 +17,8 @@ #' [`plot()`-method](https://easystats.github.io/see/articles/performance.html) #' implemented in the [**see**-package](https://easystats.github.io/see/). #' +#' @seealso [`see::plot.see_check_normality()`] for options to customize the plot. +#' #' @details `check_normality()` calls `stats::shapiro.test` and checks the #' standardized residuals (or studentized residuals for mixed models) for #' normal distribution. Note that this formal test almost always yields diff --git a/R/check_outliers.R b/R/check_outliers.R index a589b1309..adb4165dc 100644 --- a/R/check_outliers.R +++ b/R/check_outliers.R @@ -47,6 +47,8 @@ #' #' @family functions to check model assumptions and and assess model quality #' +#' @seealso [`see::plot.see_check_outliers()`] for options to customize the plot. +#' #' @note There is also a #' [`plot()`-method](https://easystats.github.io/see/articles/performance.html) #' implemented in the diff --git a/R/check_predictions.R b/R/check_predictions.R index 69222d7f8..eaa94219b 100644 --- a/R/check_predictions.R +++ b/R/check_predictions.R @@ -37,7 +37,8 @@ #' #' @return A data frame of simulated responses and the original response vector. #' -#' @seealso [`simulate_residuals()`] and [`check_residuals()`]. +#' @seealso [`simulate_residuals()`] and [`check_residuals()`]. See also +#' [`see::print.see_performance_pp_check()`] for options to customize the plot. #' #' @details An example how posterior predictive checks can also be used for model #' comparison is Figure 6 from _Gabry et al. 2019, Figure 6_. diff --git a/R/check_residuals.R b/R/check_residuals.R index d8840e165..d467bf354 100644 --- a/R/check_residuals.R +++ b/R/check_residuals.R @@ -20,7 +20,8 @@ #' @inheritSection simulate_residuals Tests based on simulated residuals #' #' @seealso [`simulate_residuals()`], [`check_zeroinflation()`], -#' [`check_overdispersion()`] and [`check_predictions()`]. +#' [`check_overdispersion()`] and [`check_predictions()`]. See also +#' [`see::plot.see_performance_simres()`] for options to customize the plot. #' #' @return The p-value of the test statistics. #' diff --git a/R/simulate_residuals.R b/R/simulate_residuals.R index 41fccea55..7312c196f 100644 --- a/R/simulate_residuals.R +++ b/R/simulate_residuals.R @@ -21,7 +21,8 @@ #' `performance_simres`. #' #' @seealso [`check_residuals()`], [`check_zeroinflation()`], -#' [`check_overdispersion()`] and [`check_predictions()`]. +#' [`check_overdispersion()`] and [`check_predictions()`]. See also +#' [`see::plot.see_performance_simres()`] for options to customize the plot. #' #' @details This function is a small wrapper around [`DHARMa::simulateResiduals()`]. #' It basically only sets `plot = FALSE` and adds an additional class attribute diff --git a/man/check_collinearity.Rd b/man/check_collinearity.Rd index 9b943758d..847ff110d 100644 --- a/man/check_collinearity.Rd +++ b/man/check_collinearity.Rd @@ -160,6 +160,8 @@ Evolution (2010) 1:3–14. } } \seealso{ +\code{\link[see:plot.see_check_collinearity]{see::plot.see_check_collinearity()}} for options to customize the plot. + Other functions to check model assumptions and and assess model quality: \code{\link{check_autocorrelation}()}, \code{\link{check_convergence}()}, diff --git a/man/check_normality.Rd b/man/check_normality.Rd index 282aa6016..7388e0c0b 100644 --- a/man/check_normality.Rd +++ b/man/check_normality.Rd @@ -60,3 +60,6 @@ plot(check_normality(m), type = "pp") } \dontshow{\}) # examplesIf} } +\seealso{ +\code{\link[see:plot.see_check_normality]{see::plot.see_check_normality()}} for options to customize the plot. +} diff --git a/man/check_outliers.Rd b/man/check_outliers.Rd index 84a381985..c75d5fc4a 100644 --- a/man/check_outliers.Rd +++ b/man/check_outliers.Rd @@ -392,6 +392,8 @@ association, 85(411), 633-639. } } \seealso{ +\code{\link[see:plot.see_check_outliers]{see::plot.see_check_outliers()}} for options to customize the plot. + Other functions to check model assumptions and and assess model quality: \code{\link{check_autocorrelation}()}, \code{\link{check_collinearity}()}, diff --git a/man/check_predictions.Rd b/man/check_predictions.Rd index e64b306fb..148df6994 100644 --- a/man/check_predictions.Rd +++ b/man/check_predictions.Rd @@ -117,7 +117,8 @@ Cambridge University Press. } } \seealso{ -\code{\link[=simulate_residuals]{simulate_residuals()}} and \code{\link[=check_residuals]{check_residuals()}}. +\code{\link[=simulate_residuals]{simulate_residuals()}} and \code{\link[=check_residuals]{check_residuals()}}. See also +\code{\link[see:print.see_performance_pp_check]{see::print.see_performance_pp_check()}} for options to customize the plot. Other functions to check model assumptions and and assess model quality: \code{\link{check_autocorrelation}()}, diff --git a/man/check_residuals.Rd b/man/check_residuals.Rd index 6935c242c..972b9783e 100644 --- a/man/check_residuals.Rd +++ b/man/check_residuals.Rd @@ -62,5 +62,6 @@ check_residuals(res) } \seealso{ \code{\link[=simulate_residuals]{simulate_residuals()}}, \code{\link[=check_zeroinflation]{check_zeroinflation()}}, -\code{\link[=check_overdispersion]{check_overdispersion()}} and \code{\link[=check_predictions]{check_predictions()}}. +\code{\link[=check_overdispersion]{check_overdispersion()}} and \code{\link[=check_predictions]{check_predictions()}}. See also +\code{\link[see:plot.see_performance_simres]{see::plot.see_performance_simres()}} for options to customize the plot. } diff --git a/man/simulate_residuals.Rd b/man/simulate_residuals.Rd index 938f8b0d2..493461cda 100644 --- a/man/simulate_residuals.Rd +++ b/man/simulate_residuals.Rd @@ -81,5 +81,6 @@ of Computational and Graphical Statistics, 5(3), 236. \doi{10.2307/1390802} } \seealso{ \code{\link[=check_residuals]{check_residuals()}}, \code{\link[=check_zeroinflation]{check_zeroinflation()}}, -\code{\link[=check_overdispersion]{check_overdispersion()}} and \code{\link[=check_predictions]{check_predictions()}}. +\code{\link[=check_overdispersion]{check_overdispersion()}} and \code{\link[=check_predictions]{check_predictions()}}. See also +\code{\link[see:plot.see_performance_simres]{see::plot.see_performance_simres()}} for options to customize the plot. }