Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Check {insight} API / documentation on API #937

Closed
strengejacke opened this issue Oct 1, 2024 · 0 comments · Fixed by #938
Closed

Check {insight} API / documentation on API #937

strengejacke opened this issue Oct 1, 2024 · 0 comments · Fixed by #938
Assignees
Labels
Consistency 🍏 🍎 Expected output across functions or API design could be more similar Docs 📚 Something to be adressed in docs and/or vignettes
Milestone

Comments

@strengejacke
Copy link
Member

strengejacke commented Oct 1, 2024

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() or insight::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:

  • What to do to add new methods for extracting/tidying parameters? That would only require a method for model_parameters().
  • What to do to add new methods for some easystats support? (I'm thinking of check_model(), which seems to be often used by users) This would probably require some more methods - must check.
  • What to do to add new methods for full easystats support? This would need methods in insight, maybe also parameters or bayestestR.
@strengejacke strengejacke added Docs 📚 Something to be adressed in docs and/or vignettes Consistency 🍏 🍎 Expected output across functions or API design could be more similar labels Oct 1, 2024
@strengejacke strengejacke modified the milestones: 1.0.0, Release 1.0.0 Oct 2, 2024
@strengejacke strengejacke self-assigned this Oct 2, 2024
strengejacke added a commit that referenced this issue Oct 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Consistency 🍏 🍎 Expected output across functions or API design could be more similar Docs 📚 Something to be adressed in docs and/or vignettes
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant