bayesplot icon indicating copy to clipboard operation
bayesplot copied to clipboard

Missing documentation for ppc_data and ppc_loo_pitdata

Open bnicenboim opened this issue 6 years ago • 4 comments

I wanted to create new ppc_ functions, and I've noticed ppc_data. The issue is the following: Is the documentation of this "external" function missing? Or is it an internal function exported mistake?

bnicenboim avatar Nov 28 '19 13:11 bnicenboim

We want it to be exported. It could use documentation.

tjmahr avatar Nov 28 '19 14:11 tjmahr

ok, the intended use is that the user would make their own ppc_functions, right?

bnicenboim avatar Nov 29 '19 05:11 bnicenboim

Or make their own custom plots. The idea is that each bayesplot function does two things.

  1. Prepares the MCMC or PPC draws for plotting with ggplot2 by creating a dataframe or list of dataframes.
  2. Plots the prepared data.

ppc_data() is the data-preparation function for the ppc_() plots.

tjmahr avatar Dec 02 '19 19:12 tjmahr

Documentation for ppc_data() is still missing from the page https://mc-stan.org/bayesplot/reference/PPC-distributions.html

In the same way, there is undocumented ppc_loo_pit_data() in https://mc-stan.org/bayesplot/reference/PPC-loo.html

avehtari avatar Nov 28 '22 19:11 avehtari