easystats / insight

:crystal_ball: Easy access to model information for various model objects
https://easystats.github.io/insight/
GNU General Public License v3.0
404 stars 39 forks source link

Document API #946

Open strengejacke opened 1 month ago

strengejacke commented 1 month ago

See https://github.com/easystats/easystats/issues/73

To add support for models, especially for parameters and including all features, we need following methods:

In other packages, these are optional, when the above methods work fine:

The simple way is just adding a method for parameters::model_parameters(), however, than this model-class is not supported by all functions we offer in the easystats eco-system.

I think we need a vignette on the API, explaining how to add methods/support for new models, similar to what @mattansb has done here: https://easystats.github.io/effectsize/articles/effectsize_API.html

Maybe we can split those vignettes into two (or more?) parts: