docs

easystats · Nov 19, 2024 · 110b219 · 110b219
1 parent 01ee6a5
commit 110b219
Show file tree

Hide file tree

Showing 18 changed files with 82 additions and 170 deletions.
diff --git a/R/methods_FactoMineR.R b/R/methods_FactoMineR.R
@@ -1,5 +1,3 @@
-#' @inheritParams model_parameters.default
-#' @rdname model_parameters.principal
 #' @export
 model_parameters.PCA <- function(model,
                                  sort = FALSE,

diff --git a/R/methods_bife.R b/R/methods_bife.R
@@ -19,9 +19,8 @@ p_value.bife <- function(model, ...) {
   )
 }
 
-#' @rdname model_parameters.mlm
-#' @export
 
+#' @export
 model_parameters.bifeAPEs <- function(model, ...) {
   est <- model[["delta"]]
   se <- sqrt(diag(model[["vcov"]]))

diff --git a/R/methods_brglm2.R b/R/methods_brglm2.R
@@ -5,7 +5,6 @@
 ############# .bracl --------------
 
 
-#' @rdname model_parameters.mlm
 #' @export
 model_parameters.bracl <- function(model,
                                    ci = 0.95,

diff --git a/R/methods_cplm.R b/R/methods_cplm.R
@@ -51,6 +51,9 @@
 #' - **mvord**: `"thresholds"` and `"correlation"`
 #' - **clm2**: `"scale"`
 #' - **selection**: `"selection"`, `"outcome"`, and `"auxiliary"`
+#' - **lavaan**: One or more of `"regression"`, `"correlation"`, `"loading"`,
+#'   `"variance"`, `"defined"`, or `"mean"`. Can also be `"all"` to include
+#'   all components.
 #'
 #' For models of class `brmsfit` (package **brms**), even more options are
 #' possible for the `component` argument, which are not all documented in detail

diff --git a/R/methods_lavaan.R b/R/methods_lavaan.R
@@ -4,12 +4,11 @@
 # model parameters ---------------------------
 
 
-#' @rdname model_parameters.principal
 #' @export
 model_parameters.lavaan <- function(model,
                                     ci = 0.95,
                                     standardize = FALSE,
-                                    component = c("regression", "correlation", "loading", "defined"),
+                                    component = "regression",
                                     keep = NULL,
                                     drop = NULL,
                                     verbose = TRUE,

diff --git a/R/methods_mice.R b/R/methods_mice.R
@@ -67,7 +67,6 @@ format_parameters.mira <- format_parameters.rma
 
 # model_parameters ---------------------------------
 
-#' @rdname model_parameters.mira
 #' @export
 model_parameters.mipo <- function(model,
                                   ci = 0.95,

diff --git a/R/methods_ordinal.R b/R/methods_ordinal.R
@@ -1,7 +1,5 @@
 # model parameters -------------------
 
-
-#' @rdname model_parameters.mlm
 #' @export
 model_parameters.clm2 <- function(model,
                                   ci = 0.95,

diff --git a/man/ci.default.Rd b/man/ci.default.Rd
diff --git a/man/model_parameters.brmsfit.Rd b/man/model_parameters.brmsfit.Rd
diff --git a/man/model_parameters.glimML.Rd b/man/model_parameters.glimML.Rd
diff --git a/man/model_parameters.glmmTMB.Rd b/man/model_parameters.glmmTMB.Rd
diff --git a/man/model_parameters.mira.Rd b/man/model_parameters.mira.Rd
diff --git a/man/model_parameters.mlm.Rd b/man/model_parameters.mlm.Rd
diff --git a/man/model_parameters.principal.Rd b/man/model_parameters.principal.Rd