Package cheatsheet with thumbnail plots or an example gallery
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 38/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Quiet
- Tech stack
- r
- Domain
- data-visualization, documentation
Research direction
Start with the Functions overview and the PPC-errors documentation page mentioned in the issue, then compare the ArviZ example gallery. Done means the overview provides a cheatsheet or gallery with rendered example plots and plotting functions link to focused help rather than only family-level documentation.
Written by the indexing model from the issue text.
Description
Summary
Currently, the bayesplot "Functions" overview provides only a structured list of function links. For better user orientation it would be helpful to provide something like a one-page cheatsheet or an example gallery that shows the functions with small rendered example plots. See for example how ArviZ handels this: https://python.arviz.org/projects/plots/en/latest/gallery/index.html.
In this context, it would also be helpful to get help in the documentation for specific plotting functions, without being forwarded to a documentation page that provides help for the entire "function family" (see for example https://mc-stan.org/bayesplot/reference/PPC-errors.html).
- Dominant language
- R
- Stars
- 442
- Forks
- 93
- Avg merge
- 3h 17m
- Merged PRs (30d)
- 2
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from stan-dev/bayesplot
-
documentation
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
pp_check and rvars Open
Difficulty 4/5 3-5 days Newbie friendliness 35/100
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
-
documentation
Difficulty 5/5 Over a week Newbie friendliness 35/100
All issues in stan-dev/bayesplot
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
robjhyndman/forecast#1220 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
JamesHWade/deputy#192 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
bug triage_needed
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
pharmaverse/rtables#1123 · 1 comment · 1 reaction ·