performance icon indicating copy to clipboard operation
performance copied to clipboard

Documentation for `check_model()`

Open strengejacke opened this issue 3 years ago • 14 comments

@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 https://github.com/easystats/see/issues/211#issuecomment-1056397023

strengejacke avatar Mar 02 '22 10:03 strengejacke

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

bwiernik avatar Mar 02 '22 10:03 bwiernik

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.

strengejacke avatar Mar 02 '22 11:03 strengejacke

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

mattansb avatar Mar 02 '22 11:03 mattansb

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)

bwiernik avatar Mar 02 '22 14:03 bwiernik

Agreed.

mattansb avatar Mar 02 '22 15:03 mattansb

ok, makes sense.

strengejacke avatar Mar 02 '22 16:03 strengejacke

Anyone who is willing to make a first draft?

strengejacke avatar Mar 15 '22 10:03 strengejacke

(bump)

strengejacke avatar Mar 22 '22 10:03 strengejacke

(bump)

strengejacke avatar Mar 29 '22 17:03 strengejacke

Will start on it this weekend

bwiernik avatar Mar 29 '22 18:03 bwiernik

bump

strengejacke avatar Jun 09 '22 12:06 strengejacke

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

strengejacke avatar Jun 15 '22 06:06 strengejacke

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

bwiernik avatar Jun 26 '22 23:06 bwiernik

bump

IndrajeetPatil avatar Aug 08 '22 20:08 IndrajeetPatil

bump

IndrajeetPatil avatar Jan 11 '23 22:01 IndrajeetPatil

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.

strengejacke avatar Apr 04 '23 12:04 strengejacke