Add xrefs to see package (#702)

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

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

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

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

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_.

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.
 #'

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