Check {insight} API / documentation on API #937
Labels
Consistency 🍏 🍎
Expected output across functions or API design could be more similar
Docs 📚
Something to be adressed in docs and/or vignettes
Milestone
See easystats/easystats#73
To add support for models, especially for parameters and including all features, we need following methods:
insight::find_formula()
insight::model_info()
insight::get_parameters()
insight::get_statistic()
insight::find_statistic()
insight::get_varcov()
insight::get_df()
In other packages, these are optional, when the above methods work fine:
parameters::ci()
parameters::p_value()
parameters::standard_error()
orinsight::get_varcov()
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:
model_parameters()
.check_model()
, which seems to be often used by users) This would probably require some more methods - must check.The text was updated successfully, but these errors were encountered: