stan-dev / bayesplot

bayesplot R package for plotting Bayesian models
https://mc-stan.org/bayesplot
GNU General Public License v3.0
433 stars 83 forks source link

Missing documentation for ppc_data and ppc_loo_pitdata #209

Open bnicenboim opened 4 years ago

bnicenboim commented 4 years ago

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?

tjmahr commented 4 years ago

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

bnicenboim commented 4 years ago

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

tjmahr commented 4 years ago

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.

avehtari commented 1 year ago

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