docs

R/2_ci.R

@@ -6,23 +6,22 @@
 #' @param x A statistical model.
 #' @param ci Confidence Interval (CI) level. Default to `0.95` (`95%`).
 #' @param dof Number of degrees of freedom to be used when calculating
-#'   confidence intervals. If `NULL` (default), the degrees of freedom are
-#'   retrieved by calling [`insight::get_df()`] with approximation method
-#'   defined in `method`. If not `NULL`, use this argument to override the
-#'   default degrees of freedom used to compute confidence intervals.
-#' @param method Method for computing degrees of freedom for
-#'   confidence intervals (CI) and the related p-values. Allowed are following
-#'   options (which vary depending on the model class): `"residual"`,
-#'   `"normal"`, `"likelihood"`, `"satterthwaite"`, `"kenward"`, `"wald"`,
-#'   `"profile"`, `"boot"`, `"uniroot"`, `"ml1"`, `"betwithin"`, `"hdi"`,
-#'   `"quantile"`, `"ci"`, `"eti"`, `"si"`, `"bci"`, or `"bcai"`. See section
-#'   _Confidence intervals and approximation of degrees of freedom_ in
-#'   [`model_parameters()`] for further details.
+#' confidence intervals. If `NULL` (default), the degrees of freedom are
+#' retrieved by calling [`insight::get_df()`] with approximation method defined
+#' in `method`. If not `NULL`, use this argument to override the default degrees
+#' of freedom used to compute confidence intervals.
+#' @param method Method for computing degrees of freedom for confidence
+#' intervals (CI) and the related p-values. Allowed are following options (which
+#' vary depending on the model class): `"residual"`, `"normal"`, `"likelihood"`,
+#' `"satterthwaite"`, `"kenward"`, `"wald"`, `"profile"`, `"boot"`, `"uniroot"`,
+#' `"ml1"`, `"betwithin"`, `"hdi"`, `"quantile"`, `"ci"`, `"eti"`, `"si"`,
+#' `"bci"`, or `"bcai"`. See section _Confidence intervals and approximation of
+#' degrees of freedom_ in [`model_parameters()`] for further details.
 #' @param component Model component for which parameters should be shown. See
-#'   the documentation for your object's class in [`model_parameters()`] or
-#'   [`p_value()`] for further details, or see section _Model components_.
+#' the documentation for your object's class in [`model_parameters()`] or
+#' [`p_value()`] for further details, or see section _Model components_.
 #' @param iterations The number of bootstrap replicates. Only applies to models
-#'   of class `merMod` when `method=boot`.
+#' of class `merMod` when `method=boot`.
 #' @param verbose Toggle warnings and messages.
 #' @param ... Additional arguments passed down to the underlying functions.
 #' E.g., arguments like `vcov` or `vcov_args` can be used to compute confidence
@@ -64,14 +63,23 @@ ci.default <- function(x,
                        ci = 0.95,
                        dof = NULL,
                        method = NULL,
+                       iterations = 500,
                        component = "all",
                        vcov = NULL,
                        vcov_args = NULL,
                        verbose = TRUE,
                        ...) {
   # check for valid input
   .is_model_valid(x)
-  .ci_generic(model = x, ci = ci, dof = dof, method = method, ...)
+  .ci_generic(
+    model = x,
+    ci = ci,
+    dof = dof,
+    method = method,
+    component = component,
+    vcov = vcov,
+    vcov_args = vcov_args,
+  ...)
 }
 
 

R/methods_lme4.R

@@ -188,7 +188,6 @@ model_parameters.merMod <- function(model,
 }
 
 
-#' @rdname ci.default
 #' @export
 ci.merMod <- function(x,
                       ci = 0.95,