[Feature] get_simulated (#1172)

* initial

* address comments

* rename vars

* address comments

* fix

* address comments

* fix Gemini instructions

* address comments

* add glm test

* minor code style

* stop on categorical outcomes

* code readability

* fix for binomial and data grid

* works for cbind-glm

* add tests

* test

* code readability

* add comment

* code readability

* make filtering work for glmmTMB

* fix

* namespace

* news, desc

* pkgdown

* code readability, aggregate by mode

* support Gamma and Poisson

* refactor, add helpers for other families

* fix,add tests

* fix

* fixes

* don't return data by default, but add option to include

* data cannot be null, fixes

* fixes, tests

* fix, add tests

* don't need docs for mehtods without new arguments

* docs

* add test

* add tests

* test

* typo

* typo

* fix

* fix

* add inclide_data for merMod

* check methods

* first mgcv::gam draft

* ...

* more gam families

* add beta fam

---------

Co-authored-by: Daniel <mail@danielluedecke.de>

Author: DominiqueMakowski

DESCRIPTION

@@ -1,7 +1,7 @@
 Type: Package
 Package: insight
 Title: Easy Access to Model Information for Various Model Objects
-Version: 1.4.6.10
+Version: 1.4.6.11
 Authors@R:
     c(person(given = "Daniel",
              family = "Lüdecke",

NAMESPACE

@@ -924,6 +924,47 @@ S3method(get_response,DirichletRegModel)
 S3method(get_response,bfsl)
 S3method(get_response,default)
 S3method(get_response,nestedLogit)
+S3method(get_simulated,Gam)
+S3method(get_simulated,MixMod)
+S3method(get_simulated,afex_aov)
+S3method(get_simulated,betareg)
+S3method(get_simulated,bife)
+S3method(get_simulated,bracl)
+S3method(get_simulated,brmsfit)
+S3method(get_simulated,clm)
+S3method(get_simulated,coxme)
+S3method(get_simulated,coxph)
+S3method(get_simulated,crr)
+S3method(get_simulated,data.frame)
+S3method(get_simulated,default)
+S3method(get_simulated,fa)
+S3method(get_simulated,faMain)
+S3method(get_simulated,fixest)
+S3method(get_simulated,gam)
+S3method(get_simulated,gamlss)
+S3method(get_simulated,gamm)
+S3method(get_simulated,glm)
+S3method(get_simulated,glmgee)
+S3method(get_simulated,glmmTMB)
+S3method(get_simulated,hglm)
+S3method(get_simulated,htest)
+S3method(get_simulated,hurdle)
+S3method(get_simulated,list)
+S3method(get_simulated,lm)
+S3method(get_simulated,lmerMod)
+S3method(get_simulated,lrm)
+S3method(get_simulated,merMod)
+S3method(get_simulated,multinom)
+S3method(get_simulated,phylolm)
+S3method(get_simulated,polr)
+S3method(get_simulated,prcomp)
+S3method(get_simulated,principal)
+S3method(get_simulated,rlm)
+S3method(get_simulated,rma)
+S3method(get_simulated,sdmTMB)
+S3method(get_simulated,stanreg)
+S3method(get_simulated,survreg)
+S3method(get_simulated,zeroinfl)
 S3method(get_statistic,Arima)
 S3method(get_statistic,BBmm)
 S3method(get_statistic,DirichletRegModel)
@@ -1915,6 +1956,7 @@ export(get_random)
 export(get_residuals)
 export(get_response)
 export(get_sigma)
+export(get_simulated)
 export(get_statistic)
 export(get_transformation)
 export(get_varcov)

NEWS.md

@@ -2,6 +2,13 @@
 
 ## Changes
 
+* New function, `get_simulated()`, to return simulated values from the response
+  of regression models, which is comparable to posterior predictions from a
+  model.
+
+* Improved performance of `find_parameters()` for models from package *mgcv*
+  that include random effects.
+
 * Improved performance of `find_parameters()` and `get_statistic()` for models
   from package *mgcv* that include random effects.
 

R/get_datagrid.R

@@ -1356,7 +1356,8 @@ get_datagrid.comparisons <- get_datagrid.slopes
 
 
 #' @keywords internal
-.mode_value <- function(x) {
+.mode_value <- function(x, na.rm = TRUE) {
+  # na.rm = TRUE not used, only required for "get_simulated.glmmTMB()"
   uniqv <- unique(x)
   tab <- tabulate(match(x, uniqv))
   idx <- which.max(tab)