Add documentation for ppc_data and ppc_loo_pit_data#426
Add documentation for ppc_data and ppc_loo_pit_data#426utkarshpawade wants to merge 3 commits intostan-dev:masterfrom
Conversation
There was a problem hiding this comment.
Pull request overview
Adds missing user-facing documentation for two exported PPC data-preparation helpers (ppc_data() and ppc_loo_pit_data()), clarifying that they can be called directly to build custom ggplot2 visualizations.
Changes:
- Documented
ppc_loo_pit_data()in the LOO PPC help page and updated the return-value template to cover_data()helpers. - Documented
ppc_data()in the PPC distributions help page as a data-preparation helper. - Added a NEWS entry noting the new documentation.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
man/PPC-loo.Rd |
Updates value text and adds a Plot Descriptions entry for ppc_loo_pit_data(). |
man/PPC-distributions.Rd |
Adds a Plot Descriptions entry for ppc_data(). |
R/ppc-loo.R |
Switches to @template return-ggplot-or-data and adds roxygen text for ppc_loo_pit_data(). |
R/ppc-distributions.R |
Adds roxygen text describing ppc_data() as a plotting data helper. |
NEWS.md |
Adds a bullet noting documentation for ppc_data() / ppc_loo_pit_data(). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…ted the return type to data frame, and refined wording to avoid overclaiming functionality
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #426 +/- ##
=======================================
Coverage 98.63% 98.63%
=======================================
Files 35 35
Lines 5860 5860
=======================================
Hits 5780 5780
Misses 80 80 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
1da6406 to
a8260cf
Compare
9e56fbb to
7195e72
Compare
|
The ubuntu-latest (devel) failure is pre-existing on stan-dev:master and is not related to this PR. It was introduced when PR #424 was merged into master today. The changes in this PR are documentation-only (NEWS.md, roxygen docs) and do not affect any plots, test logic, or snapshot files. The 5 other CI checks all pass ✅. |
Fixes #209
Changes
ppc_data()in PPC-distributions help pageppc_loo_pit_data()in PPC-loo help pageTesting