Prepare CRAN release (#1070)

* Prepare CRAN release

* cran comments

Author: strengejacke

DESCRIPTION

@@ -1,7 +1,7 @@
 Type: Package
 Package: parameters
 Title: Processing of Model Parameters
-Version: 0.24.1.4
+Version: 0.24.2
 Authors@R:
     c(person(given = "Daniel",
              family = "Lüdecke",
@@ -226,4 +226,3 @@ Config/testthat/edition: 3
 Config/testthat/parallel: true
 Config/Needs/website: easystats/easystatstemplate
 Config/rcmdcheck/ignore-inconsequential-notes: true
-Remotes: easystats/insight

NEWS.md

@@ -1,10 +1,10 @@
-# parameters (devel)
+# parameters 0.24.2
 
 ## Changes
 
 * The `effects` argument in `model_parameters()` for classes `merMod`, `glmmTMB`,
-  `brmsfit` and `stanreg` gets an additional `"total"` option, to return the
-  overall coefficient for random effects (sum of fixed and random effects).
+  `brmsfit` and `stanreg` gets an additional `"random_total"` option, to return
+  the overall coefficient for random effects (sum of fixed and random effects).
 
 ## Bug fixes
 

R/methods_brms.R

@@ -105,7 +105,7 @@ model_parameters.brmsfit <- function(model,
       drop_parameters = drop,
       ...
     )
-  } else if (identical(effects, "total")) {
+  } else if (effects %in% c("total", "random_total")) {
     # group level total effects (coef())
     params <- .group_level_total(model, centrality, dispersion, ci, ci_method, test, rope_range, rope_ci, ...)
     params$Effects <- "total"

R/methods_glmmTMB.R

@@ -12,9 +12,9 @@
 #' @param model A mixed model.
 #' @param effects Should parameters for fixed effects (`"fixed"`), random
 #'   effects (`"random"`), both fixed and random effects (`"all"`), or the
-#'   overall (sum of fixed and random) effects (`"total"`) be returned? Only
-#'   applies to mixed models. May be abbreviated. If the calculation of random
-#'   effects parameters takes too long, you may use `effects = "fixed"`.
+#'   overall (sum of fixed and random) effects (`"random_total"`) be returned?
+#'   Only applies to mixed models. May be abbreviated. If the calculation of
+#'   random effects parameters takes too long, you may use `effects = "fixed"`.
 #' @param wb_component Logical, if `TRUE` and models contains within- and
 #'   between-effects (see `datawizard::demean()`), the `Component` column
 #'   will indicate which variables belong to the within-effects,
@@ -194,15 +194,15 @@ model_parameters.glmmTMB <- function(model,
   # which components to return?
   effects <- insight::validate_argument(
     effects,
-    c("fixed", "random", "total", "all")
+    c("fixed", "random", "total", "random_total", "all")
   )
   component <- insight::validate_argument(
     component,
     c("all", "conditional", "zi", "zero_inflated", "dispersion")
   )
 
   # for coef(), we don't need all the attributes and just stop here
-  if (effects == "total") {
+  if (effects %in% c("total", "random_total")) {
     params <- .group_level_total(model)
     params$Effects <- "total"
     class(params) <- c("parameters_coef", "see_parameters_coef", class(params))

R/methods_lme4.R

@@ -55,11 +55,14 @@ model_parameters.merMod <- function(model,
   }
 
   # which component to return?
-  effects <- insight::validate_argument(effects, c("fixed", "random", "total", "all"))
+  effects <- insight::validate_argument(
+    effects,
+    c("fixed", "random", "total", "random_total", "all")
+  )
   params <- params_random <- params_variance <- NULL
 
   # for coef(), we don't need all the attributes and just stop here
-  if (effects == "total") {
+  if (effects %in% c("total", "random_total")) {
     params <- .group_level_total(model)
     params$Effects <- "total"
     class(params) <- c("parameters_coef", "see_parameters_coef", class(params))

R/methods_rstanarm.R

@@ -19,7 +19,7 @@ model_parameters.stanreg <- function(model,
                                      verbose = TRUE,
                                      ...) {
   # for coef(), we don't need all the attributes and just stop here
-  if (effects == "total") {
+  if (effects %in% c("total", "random_total")) {
     params <- .group_level_total(model)
     params$Effects <- "total"
     class(params) <- c("parameters_coef", "see_parameters_coef", class(params))

cran-comments.md

@@ -1 +1 @@
-This release fixes CRAN check issues.
+Maintainance release, in preparation for the *modelbased* submission.