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

Documentation for check_model() #395

Closed
strengejacke opened this issue Mar 2, 2022 · 15 comments · Fixed by #574 · May be fixed by #575
Closed

Documentation for check_model() #395

strengejacke opened this issue Mar 2, 2022 · 15 comments · Fixed by #574 · May be fixed by #575
Labels
Docs 📚 Something to be adressed in docs and/or vignettes

Comments

@strengejacke
Copy link
Member

@bwiernik @IndrajeetPatil @DominiqueMakowski @mattansb I think a very common question is how to interprete these plots. We already have some more details in the docs, but probably we should provide some guidelines about the meaning of these plots in the docs:

https://easystats.github.io/performance/reference/check_model.html

Originally posted by @strengejacke in easystats/see#211 (comment)

@strengejacke strengejacke added the Docs 📚 Something to be adressed in docs and/or vignettes label Mar 2, 2022
@bwiernik
Copy link
Contributor

bwiernik commented Mar 2, 2022

We should split the docs up by model type like with parameters

@strengejacke
Copy link
Member Author

Maybe:

  1. Generic plots (seen for all model types)
  2. specific plots linear/...
  3. specific plots glm/...
  4. specific plots mixed models/...

?

There is some overlap between those types.

@mattansb
Copy link
Member

mattansb commented Mar 2, 2022

I think perhaps a vignette would be better than r-docs, what do you think? With a section for linear, count, binomial, mixed, etc...

@bwiernik
Copy link
Contributor

bwiernik commented Mar 2, 2022

I would prefer them to be organized around model type, rather than type of plot, because the same plot might be used for different things for different models (eg, a scale-location plot is used to check homogeneity in a linear model, but overdispersion in a count model)

@mattansb
Copy link
Member

mattansb commented Mar 2, 2022

Agreed.

@strengejacke
Copy link
Member Author

ok, makes sense.

@strengejacke
Copy link
Member Author

Anyone who is willing to make a first draft?

@strengejacke
Copy link
Member Author

(bump)

1 similar comment
@strengejacke
Copy link
Member Author

(bump)

@bwiernik
Copy link
Contributor

Will start on it this weekend

@strengejacke
Copy link
Member Author

bump

@strengejacke
Copy link
Member Author

I'd like to submit performance soon, do you think we can add some stuff to the docs?

@bwiernik
Copy link
Contributor

I'm writing a draft of this vignette on my flight today.

@IndrajeetPatil
Copy link
Member

bump

@strengejacke
Copy link
Member Author

I hope you landed safely, Brenton. :-D
Can you look at https://easystats.github.io/performance/reference/check_model.html and maybe add/revise there? It's probably faster for now than writing a whole vignette.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs 📚 Something to be adressed in docs and/or vignettes
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants