docs

R/1_model_parameters.R

@@ -10,8 +10,9 @@
 #' - [Default method][model_parameters.default()]: `lm`, `glm`, **stats**, **censReg**,
 #'   **MASS**, **survey**, ...
 #' - [Additive models][model_parameters.cgam()]: **bamlss**, **gamlss**, **mgcv**,
-#'   **scam**, **VGAM**, `Gam`, `gamm`, ...
-#' - [ANOVA][model_parameters.aov()]: **afex**, `aov`, `anova`, ...
+#'   **scam**, **VGAM**, `Gam` (although the output of `Gam` is more Anova-alike),
+#'   `gamm`, ...
+#' - [ANOVA][model_parameters.aov()]: **afex**, `aov`, `anova`, `Gam`, ...
 #' - [Bayesian][model_parameters.stanreg()]: **BayesFactor**, **blavaan**, **brms**,
 #'   **MCMCglmm**, **posterior**, **rstanarm**, `bayesQR`, `bcplm`, `BGGM`, `blmrm`,
 #'   `blrm`, `mcmc.list`, `MCMCglmm`, ...

R/methods_MCMCglmm.R

@@ -21,7 +21,6 @@ p_value.MCMCglmm <- function(model, ...) {
 }
 
 
-#' @rdname model_parameters.stanreg
 #' @export
 model_parameters.MCMCglmm <- function(model,
                                       centrality = "median",

R/methods_aod.R

@@ -6,23 +6,28 @@
 
 #################### .glimML ------
 
-#' Parameters from special models
+#' @title Parameters from special models
+#' @name model_parameters.glimML
 #'
-#' Parameters from special regression models not listed under one of the previous categories yet.
+#' @description
+#' Parameters from special regression models not listed under one of the
+#' previous categories yet.
 #'
 #' @param component Model component for which parameters should be shown. May be
-#'   one of `"conditional"`, `"precision"` (**betareg**),
-#'   `"scale"` (**ordinal**), `"extra"` (**glmx**),
-#'   `"marginal"` (**mfx**), `"conditional"` or `"full"` (for
-#'   `MuMIn::model.avg()`) or `"all"`.
+#' one of `"conditional"`, `"precision"` (e.g. **betareg**), `"scale"` (e.g.
+#' **ordinal**), `"extra"` (e.g. **glmx**), `"marginal"` (e.g. **mfx**),
+#' `"conditional"` or `"full"` (for `MuMIn::model.avg()`) or `"all"`. See section
+#' _Model components_ for an overview of possible options for `component`.
 #' @param include_studies Logical, if `TRUE` (default), includes parameters
 #'   for all studies. Else, only parameters for overall-effects are shown.
 #' @inheritParams model_parameters.default
 #' @inheritParams model_parameters.stanreg
 #' @inheritParams simulate_model
 #'
-#' @seealso [insight::standardize_names()] to rename
-#'   columns into a consistent, standardized naming scheme.
+#' @seealso [insight::standardize_names()] to rename columns into a consistent,
+#' standardized naming scheme.
+#'
+#' @inheritSection model_parameters.zcpglm Model components
 #'
 #' @examples
 #' library(parameters)

R/methods_base.R

@@ -1,4 +1,3 @@
-#' @rdname model_parameters.stanreg
 #' @export
 model_parameters.data.frame <- function(model,
                                         as_draws = FALSE,

R/methods_brms.R

@@ -1,4 +1,3 @@
-#' @rdname model_parameters.stanreg
 #' @inheritParams insight::get_parameters
 #' @export
 model_parameters.brmsfit <- function(model,
@@ -209,11 +208,17 @@ model_parameters.brmsfit <- function(model,
 
 #' @export
 standard_error.brmsfit <- function(model,
-                                   effects = c("fixed", "random"),
-                                   component = c("all", "conditional", "zi", "zero_inflated"),
+                                   effects = "fixed",
+                                   component = "all",
                                    ...) {
-  effects <- match.arg(effects)
-  component <- match.arg(component)
+  effects <- insight::validate_argument(
+    effects,
+    c("fixed", "random")
+  )
+  component <- insight::validate_argument(
+    component,
+    c("all", "conditional", "zi", "zero_inflated")
+  )
 
   params <- insight::get_parameters(model, effects = effects, component = component, ...)
 

R/methods_cplm.R

@@ -52,9 +52,9 @@
 #' - **clm2**: `"scale"`
 #' - **selection**: `"selection"`, `"outcome"`, and `"auxiliary"`
 #'
-#' For models of class `brmsfit` (package **brms**), `component`, even more
-#' options are possible for the `component` argument, which are not all
-#' documented in detail here.
+#' For models of class `brmsfit` (package **brms**), even more options are
+#' possible for the `component` argument, which are not all documented in detail
+#' here.
 #'
 #' @examples
 #' library(parameters)

R/methods_posterior.R

@@ -1,4 +1,3 @@
-#' @rdname model_parameters.stanreg
 #' @export
 model_parameters.draws <- function(model,
                                    centrality = "median",

R/methods_rstanarm.R

@@ -33,19 +33,21 @@
 #' @inheritParams bayestestR::describe_posterior
 #' @inheritParams insight::get_parameters
 #'
-#' @seealso [insight::standardize_names()] to
-#'   rename columns into a consistent, standardized naming scheme.
+#' @seealso [insight::standardize_names()] to rename columns into a consistent,
+#' standardized naming scheme.
 #'
-#' @note When `standardize = "refit"`, columns `diagnostic`,
-#'   `bf_prior` and `priors` refer to the *original*
-#'   `model`. If `model` is a data frame, arguments `diagnostic`,
-#'   `bf_prior` and `priors` are ignored. \cr \cr There is also a
-#'   [`plot()`-method](https://easystats.github.io/see/articles/parameters.html)
-#'   implemented in the
-#'   [**see**-package](https://easystats.github.io/see/).
+#' @note When `standardize = "refit"`, columns `diagnostic`, `bf_prior` and
+#' `priors` refer to the *original* `model`. If `model` is a data frame,
+#' arguments `diagnostic`, `bf_prior` and `priors` are ignored.
+#'
+#' There is also a
+#' [`plot()`-method](https://easystats.github.io/see/articles/parameters.html)
+#' implemented in the [**see**-package](https://easystats.github.io/see/).
 #'
 #' @inheritSection model_parameters Confidence intervals and approximation of degrees of freedom
 #'
+#' @inheritSection model_parameters.zcpglm Model components
+#'
 #' @examples
 #' \donttest{
 #' library(parameters)

R/utils_model_parameters.R

@@ -458,7 +458,7 @@
       not_allowed_string <- datawizard::text_concatenate(not_allowed, enclose = "\"")
       insight::format_alert(
         sprintf("Following arguments are not supported in `%s()` for models of class `%s` and will be ignored: %s", function_name, model_class, not_allowed_string), # nolint
-        sprintf("Please run `%s()` again without specifying the above mentioned arguments to obtain expected results.", function_name) # nolint
+        sprintf("In case you obtain expected results, please run `%s()` again without specifying the above mentioned arguments.", function_name) # nolint
       )
     }
     dots[not_allowed] <- NULL