Add documentation for ppc_data and ppc_loo_pit_data#426
Open
utkarshpawade wants to merge 2 commits intostan-dev:masterfrom
Open
Add documentation for ppc_data and ppc_loo_pit_data#426utkarshpawade wants to merge 2 commits intostan-dev:masterfrom
utkarshpawade wants to merge 2 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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #209
Changes
ppc_data()in PPC-distributions help pageppc_loo_pit_data()in PPC-loo help pageTesting