Fix ppc-distribution docs for argument usage & correct test function (#366)

NEWS.md

@@ -1,5 +1,8 @@
 # bayesplot (development version)
 
+* Improved documentation for `binwidth`, `bins`, and `breaks` arguments to clarify they are passed to `ggplot2::geom_area()` and `ggdist::stat_dots()` in addition to `ggplot2::geom_histogram()`
+* Improved documentation for `freq` argument to clarify it applies to frequency polygons in addition to histograms
+* Fixed test in `test-ppc-distributions.R` that incorrectly used `ppc_dens()` instead of `ppd_dens()` when testing PPD functions
 * New functions `mcmc_dots` and `mcmc_dots_by_chain` for dot plots of MCMC draws by @behramulukir (#402)
 * Default to `quantiles=100` for all dot plots by @behramulukir (#402)
 

man-roxygen/args-hist-freq.R

@@ -1,5 +1,5 @@
-#' @param freq For histograms, `freq=TRUE` (the default) puts count on the
-#'   y-axis. Setting `freq=FALSE` puts density on the y-axis. (For many
-#'   plots the y-axis text is off by default. To view the count or density
-#'   labels on the y-axis see the [yaxis_text()] convenience
+#' @param freq For histograms and frequency polygons, `freq=TRUE` (the default)
+#'   puts count on the y-axis. Setting `freq=FALSE` puts density on the y-axis.
+#'   (For many plots the y-axis text is off by default. To view the count or
+#'   density labels on the y-axis see the [yaxis_text()] convenience
 #'   function.)

man-roxygen/args-hist.R

@@ -1,7 +1,7 @@
-#' @param binwidth Passed to [ggplot2::geom_histogram()] to override
-#'   the default binwidth.
-#' @param bins Passed to [ggplot2::geom_histogram()] to override
-#'   the default binwidth.
-#' @param breaks Passed to [ggplot2::geom_histogram()] as an
-#'   alternative to `binwidth`.
+#' @param binwidth Passed to [ggplot2::geom_histogram()], [ggplot2::geom_area()],
+#'   and [ggdist::stat_dots()] to override the default binwidth.
+#' @param bins Passed to [ggplot2::geom_histogram()] and [ggplot2::geom_area()]
+#'   to override the default binning.
+#' @param breaks Passed to [ggplot2::geom_histogram()] as an alternative to
+#'   `binwidth`.
 #'

tests/testthat/test-ppc-distributions.R

@@ -76,8 +76,8 @@ test_that("ppc_dens,pp_hist,ppc_freqpoly,ppc_boxplot return ggplot objects", {
   expect_gg(ppd_hist(yrep[1:8, ], binwidth = 0.1))
   expect_gg(ppd_hist(yrep2, binwidth = 0.1))
 
-  expect_gg(ppc_dens(y, yrep[1:8, ]))
-  expect_gg(ppc_dens(y2, yrep2))
+  expect_gg(ppd_dens(yrep[1:8, ]))
+  expect_gg(ppd_dens(yrep2))
 
   expect_gg(ppd_freqpoly(yrep[1:8, ], binwidth = 2, size = 2, alpha = 0.1))
   expect_gg(ppd_freqpoly(yrep2, binwidth = 0.1))