Merge pull request #300 from stan-dev/hist-bins

add 'bins' argument to many histogram plots

Author: jgabry

DESCRIPTION

@@ -1,8 +1,8 @@
 Package: bayesplot
 Type: Package
 Title: Plotting for Bayesian Models
-Version: 1.10.0.9000
-Date: 2022-11-16
+Version: 1.10.0.9001
+Date: 2023-03-16
 Authors@R: c(person("Jonah", "Gabry", role = c("aut", "cre"), email = "[email protected]"),
              person("Tristan", "Mahr", role = "aut"),
              person("Paul-Christian", "Bürkner", role = "ctb"),
@@ -55,7 +55,7 @@ Suggests:
     survival,
     testthat (>= 2.0.0),
     vdiffr (>= 1.0.2)
-RoxygenNote: 7.2.2
+RoxygenNote: 7.2.3
 VignetteBuilder: knitr
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE)

R/mcmc-diagnostics.R

@@ -171,7 +171,7 @@ mcmc_rhat <- function(rhat, ..., size = NULL) {
 
 #' @rdname MCMC-diagnostics
 #' @export
-mcmc_rhat_hist <- function(rhat, ..., binwidth = NULL, breaks = NULL) {
+mcmc_rhat_hist <- function(rhat, ..., binwidth = NULL, bins = NULL, breaks = NULL) {
   check_ignored_arguments(...)
   data <- mcmc_rhat_data(rhat)
 
@@ -185,6 +185,7 @@ mcmc_rhat_hist <- function(rhat, ..., binwidth = NULL, breaks = NULL) {
       linewidth = 0.25,
       na.rm = TRUE,
       binwidth = binwidth,
+      bins = bins,
       breaks = breaks
     ) +
     scale_color_diagnostic("rhat") +
@@ -261,7 +262,7 @@ mcmc_neff <- function(ratio, ..., size = NULL) {
 
 #' @rdname MCMC-diagnostics
 #' @export
-mcmc_neff_hist <- function(ratio, ..., binwidth = NULL, breaks = NULL) {
+mcmc_neff_hist <- function(ratio, ..., binwidth = NULL, bins = NULL, breaks = NULL) {
   check_ignored_arguments(...)
   data <- mcmc_neff_data(ratio)
 
@@ -275,6 +276,7 @@ mcmc_neff_hist <- function(ratio, ..., binwidth = NULL, breaks = NULL) {
       linewidth = 0.25,
       na.rm = TRUE,
       binwidth = binwidth,
+      bins = bins,
       breaks = breaks) +
     scale_color_diagnostic("neff") +
     scale_fill_diagnostic("neff") +

R/mcmc-distributions.R

@@ -115,6 +115,7 @@ mcmc_hist <- function(
   ...,
   facet_args = list(),
   binwidth = NULL,
+  bins = NULL,
   breaks = NULL,
   freq = TRUE,
   alpha = 1
@@ -127,6 +128,7 @@ mcmc_hist <- function(
     transformations = transformations,
     facet_args = facet_args,
     binwidth = binwidth,
+    bins = bins,
     breaks = breaks,
     by_chain = FALSE,
     freq = freq,
@@ -180,6 +182,7 @@ mcmc_hist_by_chain <- function(
   ...,
   facet_args = list(),
   binwidth = NULL,
+  bins = NULL,
   freq = TRUE,
   alpha = 1
 ) {
@@ -191,6 +194,7 @@ mcmc_hist_by_chain <- function(
     transformations = transformations,
     facet_args = facet_args,
     binwidth = binwidth,
+    bins = bins,
     by_chain = TRUE,
     freq = freq,
     alpha = alpha,
@@ -369,6 +373,7 @@ mcmc_violin <- function(
   transformations = list(),
   facet_args = list(),
   binwidth = NULL,
+  bins = NULL,
   breaks = NULL,
   by_chain = FALSE,
   freq = TRUE,
@@ -392,6 +397,7 @@ mcmc_violin <- function(
       size = .25,
       na.rm = TRUE,
       binwidth = binwidth,
+      bins = bins,
       breaks = breaks,
       alpha = alpha
     )

R/mcmc-recover.R

@@ -303,6 +303,7 @@ mcmc_recover_hist <-
            ...,
            facet_args = list(),
            binwidth = NULL,
+           bins = NULL,
            breaks = NULL) {
 
     check_ignored_arguments(...)
@@ -327,6 +328,7 @@ mcmc_recover_hist <-
         color = get_color("lh"),
         linewidth = 0.25,
         binwidth = binwidth,
+        bins = bins,
         breaks = breaks
       ) +
       geom_vline(

R/ppc-distributions.R

@@ -362,6 +362,7 @@ ppc_hist <-
            yrep,
            ...,
            binwidth = NULL,
+           bins = NULL,
            breaks = NULL,
            freq = TRUE) {
     check_ignored_arguments(...)
@@ -375,6 +376,7 @@ ppc_hist <-
       geom_histogram(
         linewidth = 0.25,
         binwidth = binwidth,
+        bins = bins,
         breaks = breaks
       ) +
       scale_fill_ppc() +

R/ppc-errors.R

@@ -119,6 +119,7 @@ ppc_error_hist <-
            ...,
            facet_args = list(),
            binwidth = NULL,
+           bins = NULL,
            breaks = NULL,
            freq = TRUE) {
 
@@ -135,6 +136,7 @@ ppc_error_hist <-
         color = get_color("lh"),
         size = 0.25,
         binwidth = binwidth,
+        bins = bins,
         breaks = breaks
       ) +
       xlab(error_label()) +

R/ppc-test-statistics.R

@@ -102,6 +102,7 @@ ppc_stat <-
            stat = "mean",
            ...,
            binwidth = NULL,
+           bins = NULL,
            breaks = NULL,
            freq = TRUE) {
     stopifnot(length(stat) == 1)
@@ -127,6 +128,7 @@ ppc_stat <-
         linewidth = 0.25,
         na.rm = TRUE,
         binwidth = binwidth,
+        bins = bins,
         breaks = breaks
       ) +
       geom_vline(

R/ppd-distributions.R

@@ -156,6 +156,7 @@ ppd_hist <-
   function(ypred,
            ...,
            binwidth = NULL,
+           bins = NULL,
            breaks = NULL,
            freq = TRUE) {
     check_ignored_arguments(...)
@@ -169,6 +170,7 @@ ppd_hist <-
       geom_histogram(
         size = 0.25,
         binwidth = binwidth,
+        bins = bins,
         breaks = breaks
       ) +
       scale_color_ppd() +

R/ppd-test-statistics.R

@@ -36,6 +36,7 @@ ppd_stat <-
            stat = "mean",
            ...,
            binwidth = NULL,
+           bins = NULL,
            breaks = NULL,
            freq = TRUE) {
     stopifnot(length(stat) == 1)
@@ -59,6 +60,7 @@ ppd_stat <-
         linewidth = 0.25,
         na.rm = TRUE,
         binwidth = binwidth,
+        bins = bins,
         breaks = breaks
       ) +
       scale_color_ppd(guide = "none") +

man-roxygen/args-hist.R

@@ -1,6 +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`.
 #'