docs

NAMESPACE

@@ -264,6 +264,7 @@ S3method(plot,check_model)
 S3method(plot,check_normality)
 S3method(plot,check_outliers)
 S3method(plot,check_overdisp)
+S3method(plot,check_residuals)
 S3method(plot,check_sphericity)
 S3method(plot,compare_performance)
 S3method(plot,performance_pp_check)

R/check_residuals.R

@@ -9,7 +9,7 @@
 #' [`DHARMa::simulateResiduals()`].
 #' @param alternative A character string specifying the alternative hypothesis.
 #' See [`stats::ks.test()`] for details.
-#' @param ... Passed down to [`stats::ks.test()`]
+#' @param ... Passed down to [`stats::ks.test()`].
 #'
 #' @details Uniformity of residuals is checked using a Kolmogorov-Smirnov test.
 #'
@@ -85,3 +85,9 @@ print.check_residuals <- function(x, ...) {
 
   invisible(x)
 }
+
+#' @export
+plot.check_residuals <- function(x, ...) {
+  insight::check_if_installed("see", "for residual plots")
+  NextMethod()
+}

R/simulate_residuals.R

@@ -1,18 +1,24 @@
 #' @title Simulate randomized quantile residuals from a model
 #' @name simulate_residuals
 #'
-#' @description to do.
+#' @description Returns simulated residuals from a model. This is useful for
+#' checking the uniformity of residuals, in particular for non-Gaussian models,
+#' where the residuals are not expected to be normally distributed.
 #'
 #' @param x A model object.
 #' @param iterations Number of simulations to run.
 #' @param ... Arguments passed on to [`DHARMa::simulateResiduals()`].
 #'
 #' @return Simulated residuals, which can be further processed with
-#' [`check_residuals()`].
+#' [`check_residuals()`]. The returned object is of class `DHARMa` and
+#' `performance_simres`.
 #'
 #' @seealso [`check_residuals()`]
 #'
-#' @details Based on [`DHARMa::simulateResiduals()`]. See also `vignette("DHARMa")`.
+#' @details This function is a small wrapper around [`DHARMa::simulateResiduals()`].
+#' It basically only sets `plot = FALSE` and adds an additional class attribute
+#' (`"performance_sim_res"`), which allows using the DHARMa object in own plotting
+#' functions in the **see** package. See also `vignette("DHARMa")`.
 #'
 #' @references
 #'