Differences between get_predicted and get_predicted_ci for mixed models

Fixes #797

R/get_predicted.R

@@ -12,11 +12,14 @@
 #' with lots of caveats and complications. Read the 'Details' section for more
 #' information.
 #'
-#' `get_predicted_ci()` returns the confidence (or prediction) interval (CI)
+#' [`get_predicted_ci()`] returns the confidence (or prediction) interval (CI)
 #' associated with predictions made by a model. This function can be called
 #' separately on a vector of predicted values. `get_predicted()` usually
 #' returns confidence intervals (included as attribute, and accessible via the
-#' `as.data.frame()` method) by default.
+#' `as.data.frame()` method) by default. It is preferred to rely on the
+#' `get_predicted()` function for standard errrors and confidence intervals -
+#' use `get_predicted_ci()` only if standard errors and confidence intervals
+#' are not available otherwise.
 #'
 #' @param x A statistical model (can also be a data.frame, in which case the
 #'   second argument has to be a model).

R/get_predicted_ci.R

@@ -8,6 +8,9 @@
 #'   standard errors are calculated based on the variance-covariance matrix.
 #' @inheritParams get_predicted
 #'
+#' @details
+#' TBD.
+#'
 #' @examplesIf require("boot") && require("datawizard") && require("bayestestR")
 #' # Confidence Intervals for Model Predictions
 #' # ------------------------------------------