fixing errors, updating documentation and adding new capabilities to functions

Author: behramulukir

DESCRIPTION

@@ -41,6 +41,7 @@ Imports:
     tidyselect,
     utils
 Suggests:
+    ggdist,
     ggfortify,
     gridExtra (>= 2.2.1),
     hexbin,
@@ -55,8 +56,7 @@ Suggests:
     shinystan (>= 2.3.0),
     survival,
     testthat (>= 2.0.0),
-    vdiffr (>= 1.0.2),
-    ggdist
+    vdiffr (>= 1.0.2)
 RoxygenNote: 7.3.2
 VignetteBuilder: knitr
 Encoding: UTF-8

R/ppc-distributions.R

@@ -15,7 +15,7 @@
 #' @template args-pit-ecdf
 #' @param size,alpha Passed to the appropriate geom to control the appearance of
 #'   the predictive distributions.
-#' @param ... Currently unused.
+#' @param ... For dot plots, optional additional arguments to pass to [ggdist::stat_dots()].
 #'
 #' @template details-binomial
 #' @template return-ggplot-or-data
@@ -525,7 +525,7 @@ ppc_qdotplot <-
            binwidth = NA,
            quantiles = NA,
            freq = TRUE) {
-    check_ignored_arguments(...)
+    check_ignored_arguments(..., ok_args = c("dotsize", "layout", "stackratio", "overflow"))
 
     suggested_package("ggdist")
 
@@ -539,7 +539,7 @@ ppc_qdotplot <-
       ggdist::stat_dots(
         binwidth = binwidth,
         quantiles = quantiles,
-        overflow = "warn"
+        ...
       ) +
       scale_fill_ppc() +
       scale_color_ppc() +

R/ppd-distributions.R

@@ -195,7 +195,7 @@ ppd_qdotplot <-
            binwidth = NA,
            quantiles = NA,
            freq = TRUE) {
-    check_ignored_arguments(...)
+    check_ignored_arguments(..., ok_args = c("dotsize", "layout", "stackratio", "overflow"))
 
     suggested_package("ggdist")
 
@@ -208,7 +208,7 @@ ppd_qdotplot <-
       ggdist::stat_dots(
         binwidth = binwidth,
         quantiles = quantiles,
-        overflow = "warn"
+        ...
       ) +
       scale_color_ppd() +
       scale_fill_ppd() +

man-roxygen/args-qdotplot.R

@@ -1,3 +1,4 @@
-#' @param quantiles For dot plots, optional integer `quantiles` defines the
-#' number of quantiles to plot in dot plot to produce a quantile dot plot.
-#' If `quantiles` is `NA` (the default) then all data points are plotted.
+#' @param quantiles For dot plots, an optional integer passed to
+#'   [ggdist::stat_dots()] specifying the number of quantiles to use for a
+#'   quantile dot plot. If `quantiles` is `NA` (the default) then all data
+#'   points are plotted.

tests/testthat/_snaps/ppc-distributions/ppc-qdotplot-binwidth.new.svg

@@ -62,16 +62,16 @@ test_that("ppc_qdotplot returns a ggplot object", {
   testthat::skip_if_not_installed("ggdist")
 
   expect_gg(ppc_qdotplot(y, yrep[1:8, ]))
-  expect_gg(ppc_qdotplot(y, yrep[1,, drop = FALSE], quantiles=25))
+  expect_gg(ppc_qdotplot(y, yrep[1,, drop = FALSE], quantiles = 25))
   expect_gg(ppc_qdotplot(y, yrep[1:8, ], binwidth = 0.1))
   expect_gg(ppc_qdotplot(y2, yrep2, binwidth = 0.1, quantiles = 25))
 
-
   # ppd versions
-  expect_gg(ppd_qdotplot(y, yrep[1:8, ]))
+  expect_gg(ppd_qdotplot(yrep[1:8, ]))
   expect_gg(ppd_qdotplot(yrep[1,, drop = FALSE], quantiles = 25))
   expect_gg(ppd_qdotplot(yrep[1:8, ], binwidth = 0.1))
   expect_gg(ppd_qdotplot(yrep2, binwidth = 0.1, quantiles = 25))
+
 })
 
 test_that("ppc_pit_ecdf, ppc_pit_ecdf_grouped returns a ggplot object", {
@@ -203,26 +203,30 @@ test_that("ppc_qdotplot renders correctly", {
   vdiffr::expect_doppelganger("ppc_qdotplot (default)", p_base)
 
   p_binwidth <- ppc_qdotplot(vdiff_y, vdiff_yrep[1:8, ], binwidth = 3)
-  vdiffr::expect_doppelganger("ppc_qdotplot (binwidth)", p_binwidth)
+  expect_warning(vdiffr::expect_doppelganger("ppc_qdotplot (binwidth)", p_binwidth),
+                 "The provided binwidth will cause dots to overflow the boundaries of the geometry.")
 
   p_quantile <- ppc_qdotplot(vdiff_y, vdiff_yrep[1:8, ], quantiles = 50)
   vdiffr::expect_doppelganger("ppc_qdotplot (quantile)", p_quantile)
 
   p_quantile_binwidth <- ppc_qdotplot(vdiff_y, vdiff_yrep[1:8, ], binwidth = 3, quantiles = 50)
-  vdiffr::expect_doppelganger("ppc_qdotplot (quantile-binwidth)", p_quantile_binwidth)
+  expect_warning(vdiffr::expect_doppelganger("ppc_qdotplot (quantile-binwidth)", p_quantile_binwidth),
+                 "The provided binwidth will cause dots to overflow the boundaries of the geometry.")
 
   # ppd versions
   p_base <- ppd_qdotplot(vdiff_yrep[1:8, ])
   vdiffr::expect_doppelganger("ppd_qdotplot (default)", p_base)
 
   p_binwidth <- ppd_qdotplot(vdiff_yrep[1:8, ], binwidth = 3)
-  vdiffr::expect_doppelganger("ppd_qdotplot (binwidth)", p_binwidth)
+  expect_warning(vdiffr::expect_doppelganger("ppd_qdotplot (binwidth)", p_binwidth),
+                 "The provided binwidth will cause dots to overflow the boundaries of the geometry.")
 
   p_quantile <- ppd_qdotplot(vdiff_yrep[1:8, ], quantiles = 50)
   vdiffr::expect_doppelganger("ppd_qdotplot (quantile)", p_quantile)
 
   p_quantile_binwidth <- ppd_qdotplot(vdiff_yrep[1:8, ], binwidth = 3, quantiles = 50)
-  vdiffr::expect_doppelganger("ppd_qdotplot (quantile-binwidth)", p_quantile_binwidth)
+  expect_warning(vdiffr::expect_doppelganger("ppd_qdotplot (quantile-binwidth)", p_quantile_binwidth),
+                 "The provided binwidth will cause dots to overflow the boundaries of the geometry.")
 })
 
 test_that("ppc_ecdf_overlay renders correctly", {