docs

R/5_simulate_model.R

@@ -15,6 +15,8 @@
 #' @inheritParams bootstrap_model
 #' @inheritParams p_value
 #'
+#' @inheritSection model_parameters.zcpglm Model components
+#'
 #' @return A data frame.
 #'
 #' @seealso [`simulate_parameters()`], [`bootstrap_model()`], [`bootstrap_parameters()`]
@@ -57,9 +59,9 @@ simulate_model <- function(model, iterations = 1000, ...) {
 
 # Models with single component only -----------------------------------------
 
-
+#' @rdname simulate_model
 #' @export
-simulate_model.default <- function(model, iterations = 1000, ...) {
+simulate_model.default <- function(model, iterations = 1000, component = "all", ...) {
   # check for valid input
   .is_model_valid(model)
 
@@ -229,7 +231,11 @@ simulate_model.bracl <- simulate_model.default
 # helper -----------------------------------------
 
 
-.simulate_model <- function(model, iterations, component = "conditional", effects = "fixed", ...) {
+.simulate_model <- function(model,
+                            iterations,
+                            component = "conditional",
+                            effects = "fixed",
+                            ...) {
   if (is.null(iterations)) iterations <- 1000
 
   params <- insight::get_parameters(model, effects = effects, component = component, verbose = FALSE)

R/methods_betareg.R

@@ -63,11 +63,7 @@ model_parameters.betareg <- function(model,
 
 
 #' @export
-ci.betareg <- function(x,
-                       ci = 0.95,
-                       component = "all",
-                       verbose = TRUE,
-                       ...) {
+ci.betareg <- function(x, ci = 0.95, component = "all", verbose = TRUE, ...) {
   # validation check, warn if unsupported argument is used.
   dot_args <- .check_dots(
     dots = list(...),
@@ -83,10 +79,7 @@ ci.betareg <- function(x,
 
 
 #' @export
-standard_error.betareg <- function(model,
-                                   component = "all",
-                                   verbose = TRUE,
-                                   ...) {
+standard_error.betareg <- function(model, component = "all", verbose = TRUE, ...) {
   # validation check, warn if unsupported argument is used.
   dot_args <- .check_dots(
     dots = list(...),
@@ -117,10 +110,7 @@ standard_error.betareg <- function(model,
 
 
 #' @export
-p_value.betareg <- function(model,
-                            component = "all",
-                            verbose = TRUE,
-                            ...) {
+p_value.betareg <- function(model, component = "all", verbose = TRUE, ...) {
   # validation check, warn if unsupported argument is used.
   dot_args <- .check_dots(
     dots = list(...),
@@ -154,11 +144,11 @@ p_value.betareg <- function(model,
 
 
 #' @export
-simulate_model.betareg <- function(model,
-                                   iterations = 1000,
-                                   component = c("all", "conditional", "precision"),
-                                   ...) {
-  component <- match.arg(component)
+simulate_model.betareg <- function(model, iterations = 1000, component = "all", ...) {
+  component <- insight::validate_argument(
+    component,
+    c("all", "conditional", "precision")
+  )
   out <- .simulate_model(model, iterations, component = component, ...)
 
   class(out) <- c("parameters_simulate_model", class(out))

R/methods_glmmTMB.R

@@ -538,7 +538,6 @@ standard_error.glmmTMB <- function(model,
 # simulate model -----
 
 
-#' @rdname simulate_model
 #' @export
 simulate_model.glmmTMB <- function(model,
                                    iterations = 1000,
@@ -632,8 +631,6 @@ simulate_model.glmmTMB <- function(model,
 
 # simulate_parameters -----
 
-
-#' @rdname simulate_parameters
 #' @export
 simulate_parameters.glmmTMB <- function(model,
                                         iterations = 1000,

R/methods_glmx.R

@@ -66,8 +66,11 @@ p_value.glmx <- function(model, ...) {
 
 
 #' @export
-simulate_model.glmx <- function(model, iterations = 1000, component = c("all", "conditional", "extra"), ...) {
-  component <- match.arg(component)
+simulate_model.glmx <- function(model, iterations = 1000, component = "all", ...) {
+  component <- insight::validate_argument(
+    component,
+    c("all", "conditional", "extra")
+  )
   out <- .simulate_model(model, iterations, component = component, ...)
 
   class(out) <- c("parameters_simulate_model", class(out))

R/simulate_parameters.R

@@ -54,8 +54,6 @@ simulate_parameters <- function(model, ...) {
 }
 
 
-
-
 #' @rdname simulate_parameters
 #' @export
 simulate_parameters.default <- function(model,