Expanding the bayesplot vignette library
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- r
- Domain
- documentation
Research direction
Start by reviewing the existing introductory vignettes and the related issues #144 and #142 to understand current documentation plans. Done means adding the three proposed targeted vignettes: plot selection, a Bayesian workflow example, and ggplot2-based customization guidance.
Written by the indexing model from the issue text.
Description
Summary
While bayesplot currently offers a few introductory vignettes, the user experience could be improved by more targeted documentation. In the following three suggestions:
Suggested Vignettes
1. "Which plot should I use?"
This problem-oriented vignette would provide a structured overview (e.g., a lookup table) mapping specific diagnostic questions to their corresponding plot functions.
| Diagnostic Question | Recommended Function(s) |
|---|---|
| Did my MCMC chains mix? | mcmc_trace(), mcmc_rank_overlay() |
| Is my R-hat acceptable? | mcmc_rhat(), mcmc_rhat_hist() |
| ... | ... |
2. "Bayesplot and the Bayesian Workflow"
A workflow-oriented vignette that walks users through a complete modeling cycle using a single running example. It would demonstrate the appropriate plots for each stage.
3. "Customizing Bayesplot Outputs"
Since bayesplot returns standard ggplot objects, they can be modified using standard ggplot2 functions. However, it might be that some users are unaware of this extensibility. This vignette would guide users on how to benefit from this composability, covering topics such as: Adding layers or changing labels using the + operator, utilizing built-in color schemes and themes, customizing plot appearance via ggplot2 theme elements.
Relation to other issues
This issue is related to Issue#144 (Extend and Update vignettes) and Issue#142 (Vignette/template demonstrating how to contribute a new plotting function to bayesplot).
- 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 4/5 3-5 days Newbie friendliness 38/100
All issues in stan-dev/bayesplot
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
briandconnelly/airnow#9 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
OHDSI/CohortConstructor#774 ·
-
pre-review R TeX Track: 5 (DSAIS)
Difficulty 1/5 Under an hour Newbie friendliness 60/100
openjournals/joss-reviews#11330 · 7 comments ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100