Add vignette sections for *_data() companion functions#439
Add vignette sections for *_data() companion functions#439jgabry merged 6 commits intostan-dev:masterfrom
Conversation
Add usage examples in the PPC and MCMC vignettes showing how to use *_data() functions to extract pre-processed data for custom ggplot2 visualizations. Fixes stan-dev#435
Placed the section after "Providing an interface" and before "References" so it doesn't conflict with the *_data() section that PR stan-dev#439 adds at line 315.
|
Thank you @ishaan-arora-1 for your PR and working on this issue. I noticed that the checks currently fail as the object 'yrep' in your example code does not exist. Can you please have a look at this? In general it is a good idea to check whether you can build and render a modified .Rmd document locally. This allows you to catch already some errors. To build all vignettes you can run from the package root: Furthermore, to render the |
The vignette defines yrep_poisson and yrep_nb but never a bare yrep. Use yrep_nb (the better-fitting model) in the ppc_intervals_data() and ppc_stat_data() examples so the vignette renders without error.
Thanks a lot for catching that. The vignette defines yrep_poisson and yrep_nb but never a bare yrep and I should have caught that before pushing. il fix the pr, ill do as youve instructed. and i'll ask for a re-review once im done!! |
|
From my side this looks fine now. Can you just check the failing tests @ishaan-arora-1 ? |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #439 +/- ##
=======================================
Coverage 98.67% 98.67%
=======================================
Files 35 35
Lines 5903 5903
=======================================
Hits 5825 5825
Misses 78 78 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
Looks good to me now. Just double checking with @jgabry before merging. |
jgabry
left a comment
There was a problem hiding this comment.
Looks good to me too now, thank you!
|
The checks are running again now (I merged in master again) but once they pass we can merge |
Fixes #435
Added vignette sections in the PPC and MCMC vignettes demonstrating how to use the
*_data()companion functions for building custom ggplot2 visualizations, as requested in the issue.AI Usage policy :
Parts of the documentation were generated using an llm