Skip to content

Add documentation for ppc_data and ppc_loo_pit_data#426

Open
utkarshpawade wants to merge 2 commits intostan-dev:masterfrom
utkarshpawade:fix-209-ppc-data-docs
Open

Add documentation for ppc_data and ppc_loo_pit_data#426
utkarshpawade wants to merge 2 commits intostan-dev:masterfrom
utkarshpawade:fix-209-ppc-data-docs

Conversation

@utkarshpawade
Copy link

Fixes #209

Changes

  • Added documentation for ppc_data() in PPC-distributions help page
  • Added documentation for ppc_loo_pit_data() in PPC-loo help page
  • Both functions are now documented as data-preparation back ends
  • Users can call them directly to create custom plots with ggplot2
  • Updated NEWS.md with user-facing change

Testing

  • Both functions tested and working correctly
  • Documentation verified in help pages
  • Custom plotting example confirmed working

Copilot AI review requested due to automatic review settings February 26, 2026 11:36
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Missing documentation for ppc_data and ppc_loo_pitdata

2 participants