Support new models

[vincentarelbundock]

IF THE MODEL YOU WOULD LIKE TO SUPPORT IS NOT LISTED BELOW, PLEASE OPEN A NEW ISSUE.

It is often very easy to add support for new models. If you would like to help us do it (thanks!!!), please read this vignette on marginaleffects extensions: https://vincentarelbundock.github.io/marginaleffects/articles/extensions.html

marginaleffects only supports modeling packages released on CRAN. If you would like to add support for a non-CRAN package, your code can be hosted in the user-submitted (b
ut unsupported) code library in the vignette above.

If you cannot contribute code to support a new model, and if that model is not listed below, please open a new issue with a working example using a small publicly available dataset.

Seems possible

• ordinal::clmm2: Support ordinal::clmm and ordinal::clmm2 #1003

Challenges

Existing issues (with some notes)

• bife: bife Support Not Working Properly #949
• earth (MARS): Support earth mars #1186
• flexsurv: Support: flexsurv #320
• gamm4: Support gamm4 #947
• logitr: See code in sandbox/ and Support: logitr #516
• mrmm: Support mmrm #963 [DRAFT] adding support for the {mmrm} package #1000
• MuMIn: Feature Request: Support for model class "averaging" from MuMIn::model.avg() in R #1154
• panelr: Support: panelr #210
• stats::nls: Support: nls #326
• systemfit: Support: systemfit #836

predict problem

• alpaca: Support alpaca package #786
• bayesX
• censReg
• coxme: Support: coxme #645
• coxphw: Support timereg or coxphw packages #467
• coxrobust
• cplm
• endorse: Support: endorse #1144
• gee
• glmm
• glmnl
• ivprobit
• MASS::ridgelm
• mgcv::gamm: Support: mgcv::gamm #187
• ordinal::clm2: no prediction for each level
• ordinal::clmm: no predict method at all
• pglm
• plm::pgmm
• robust::glmRob: breaks with newdata
• timereg: Support timereg or coxphw packages #467

vcov problem

• complmrob
• bfsl no vcov method at all
• lqmm: breaks with newdata Support: lqmm #1072

Categorical / Multinomial DV

• VGAM::vglm: not just multinomial
• VGAM::vgam

Not currently planned

Spatial regression

Spatial regression models typically rely on very different data structures, and are currently considered out of scope for marginaleffects

• Support for SSN2 models #1052
• spaMM::HLfit:
• Support for SSN2 models #1052 (comment)
• Support for Spatial Regression Models #1067
• sdmTMB: Support: sdmTMB #1136

Multi-row data structure

Some multinomial models require dataset to be presented with one observation-choice combination per row. The whole marginaleffects infrastrcture is designed to create contrasts 1 row at a time, so we cannot support these.

• mlogit
• MNP Support: mnp package #1382

No formula interface

• glinternet: Support: glinternet #934

Very different object structure

• metafor: Very different input data. Likely very difficult to support. Would need code submission from an expert contributor. Support: metafor (rma, rma.mv) #604
• lavaan: Vincent has no experience with this package. We could consider this, but it would require serious code contributions. Support: lavaan #499
• R-INLA: Very different and unlikely. Support: R-INLA #342
• Apollo for choice models. Seems extremely idiosyncratic, and does not appear to supply any of the standard methods such as vcov(), coef(), or predict(). Supporting this is likely to be a major challenge. Vincent is unlikely to do this himself without significant help (or more likely a quasi-complete PR) from a contributor. https://cran.r-project.org/web/packages/apollo/index.html
• cmprsk::crr: Seems very different. Vincent will not implement this unless someone is willing to help.

Already supported via tidymodels or mlr3

• glmnet: no formula interface and already supported through tidymodels and mlr3. Support: glmnet #923
• SuperLearner: Support: SuperLearner #834

Not on CRAN

• bigmlogit: checked on 2022-06-02
• mixor: checked on 2022-03-10
• mnlogit: checked on 2023-01-11
• tobit1: checked on 2023-01-11
• ZBZIMM: Support: ZBZIMM #541

Supported by other packages

• Source: emmeans
  https://cran.r-project.org/web/packages/emmeans/vignettes/models.html
• Source: easystats
  • https://easystats.github.io/insight/
• Source: ggeffects
  • bamlss, cgam, cgamm, gamm, gamm4, MixMod, nlmer, survreg, sjstats::svyglm.nb, vgam.