Expand check_heterogeneity_bias()'s output (#812)

Co-authored-by: Mattan S. Ben-Shachar <[email protected]>

Author: strengejacke

DESCRIPTION

@@ -1,7 +1,7 @@
 Type: Package
 Package: performance
 Title: Assessment of Regression Models Performance
-Version: 0.13.0.7
+Version: 0.13.0.8
 Authors@R:
     c(person(given = "Daniel",
              family = "Lüdecke",
@@ -77,6 +77,7 @@ Imports:
     insight (>= 1.2.0),
     datawizard (>= 1.0.2),
     stats,
+    methods,
     utils
 Suggests:
     AER,
@@ -93,6 +94,7 @@ Suggests:
     CompQuadForm,
     correlation,
     cplm,
+    curl,
     dagitty,
     dbscan,
     DHARMa (>= 0.4.7),

NAMESPACE

@@ -48,6 +48,8 @@ S3method(check_collinearity,zeroinfl)
 S3method(check_concurvity,gam)
 S3method(check_distribution,default)
 S3method(check_distribution,numeric)
+S3method(check_group_variation,data.frame)
+S3method(check_group_variation,default)
 S3method(check_heteroscedasticity,default)
 S3method(check_homogeneity,afex_aov)
 S3method(check_homogeneity,default)
@@ -297,6 +299,7 @@ S3method(print,check_concurvity)
 S3method(print,check_dag)
 S3method(print,check_distribution)
 S3method(print,check_distribution_numeric)
+S3method(print,check_group_variation)
 S3method(print,check_heterogeneity_bias)
 S3method(print,check_heteroscedasticity)
 S3method(print,check_homogeneity)
@@ -339,6 +342,7 @@ S3method(print,r2_nakagawa_by_group)
 S3method(print,r2_pseudo)
 S3method(print,test_likelihoodratio)
 S3method(print,test_performance)
+S3method(print_html,check_group_variation)
 S3method(print_html,check_itemscale)
 S3method(print_html,compare_performance)
 S3method(print_html,test_performance)
@@ -557,6 +561,7 @@ export(check_convergence)
 export(check_dag)
 export(check_distribution)
 export(check_factorstructure)
+export(check_group_variation)
 export(check_heterogeneity_bias)
 export(check_heteroscedasticity)
 export(check_heteroskedasticity)

NEWS.md

@@ -2,25 +2,29 @@
 
 ## New functions
 
+* New function `check_group_variation()` to check within-/between-group
+  variability (this function will replace `check_heterogeneity_bias()` in
+  future releases.)
+
 * New functions `performance_reliability()` and `performance_dvour()`. These
   functions provide information about the reliability of group-level estimates
   (i.e., random effects) in mixed models.
 
 ## Changes
 
 * Singularity checks with `check_singularity()` are now more efficient and also
-  include the random effects for the dispersion component (from package *glmmTMB*).
-  Furthermore, a `check` argument allows to check for general singularity (for
-  the full model), or can return singularity checks for each random effects term
-  separately.
+  include the random effects for the dispersion component (from package
+  *glmmTMB*). Furthermore, a `check` argument allows to check for general
+  singularity (for the full model), or can return singularity checks for each
+  random effects term separately.
 
 ## Bug fixes
 
 * Fixed issue with wrong computation of pseudo-R2 for some models where the
   base-model (null model) was updated using the original data, which could
   include missing values. Now the model frame is used, ensuring the correct
-  number of observations in the returned base-model, thus calculating the correct
-  log-likelihood and returning the correct pseudo-R2.
+  number of observations in the returned base-model, thus calculating the
+  correct log-likelihood and returning the correct pseudo-R2.
 
 * Fixed examples in `check_outliers()`.
 
@@ -29,7 +33,8 @@
 ## Breaking changes
 
 * `check_outliers()` with `method = "optics"` now returns a further refined
-  cluster selection, by passing the `optics_xi` argument to `dbscan::extractXi()`.
+  cluster selection, by passing the `optics_xi` argument to
+  `dbscan::extractXi()`.
 
 * Deprecated arguments and alias-function-names have been removed.