Unify density-control argument defaults

Author: utkarshpawade

NEWS.md

@@ -1,5 +1,6 @@
 # bayesplot (development version)
 
+* Changed `bw`, `adjust`, `kernel`, and `n_dens` defaults to `NULL` in `ppc_dens_overlay()`, `ppc_dens_overlay_grouped()`, and `ppd_dens_overlay()`.
 * `ppc_ecdf_overlay()`, `ppc_ecdf_overlay_grouped()`, and `ppd_ecdf_overlay()` now always use `geom_step()`. The `discrete` argument is deprecated.
 * Fixed missing `drop = FALSE` in `nuts_params.CmdStanMCMC()`.
 * Replace `apply()` with `storage.mode()` for integer-to-numeric matrix conversion in `validate_predictions()`.

R/mcmc-intervals.R

@@ -805,6 +805,9 @@ compute_column_density <- function(df, group_vars, value_var, ...) {
 compute_interval_density <- function(x, interval_width = 1, n_dens = 1024,
                                      bw = NULL, adjust = NULL, kernel = NULL,
                                      bounds = NULL) {
+  bw <- bw %||% "nrd0"
+  adjust <- adjust %||% 1
+  kernel <- kernel %||% "gaussian"
   n_dens <- n_dens %||% 1024
 
   tail_width <- (1 - interval_width) / 2

R/ppc-distributions.R

@@ -170,12 +170,16 @@ ppc_dens_overlay <-
            size = 0.25,
            alpha = 0.7,
            trim = FALSE,
-           bw = "nrd0",
-           adjust = 1,
-           kernel = "gaussian",
+           bw = NULL,
+           adjust = NULL,
+           kernel = NULL,
            bounds = NULL,
-           n_dens = 1024) {
+           n_dens = NULL) {
     check_ignored_arguments(...)
+    bw <- bw %||% "nrd0"
+    adjust <- adjust %||% 1
+    kernel <- kernel %||% "gaussian"
+    n_dens <- n_dens %||% 1024
     bounds <- validate_density_bounds(bounds)
 
     data <- ppc_data(y, yrep)
@@ -224,11 +228,11 @@ ppc_dens_overlay_grouped <- function(y,
                                      size = 0.25,
                                      alpha = 0.7,
                                      trim = FALSE,
-                                     bw = "nrd0",
-                                     adjust = 1,
-                                     kernel = "gaussian",
+                                     bw = NULL,
+                                     adjust = NULL,
+                                     kernel = NULL,
                                      bounds = NULL,
-                                     n_dens = 1024) {
+                                     n_dens = NULL) {
   check_ignored_arguments(...)
 
   p_overlay <- ppc_dens_overlay(

R/ppd-distributions.R

@@ -42,12 +42,16 @@ ppd_dens_overlay <-
              size = 0.25,
              alpha = 0.7,
              trim = FALSE,
-             bw = "nrd0",
-             adjust = 1,
-             kernel = "gaussian",
+             bw = NULL,
+             adjust = NULL,
+             kernel = NULL,
              bounds = NULL,
-             n_dens = 1024) {
+             n_dens = NULL) {
       check_ignored_arguments(...)
+      bw <- bw %||% "nrd0"
+      adjust <- adjust %||% 1
+      kernel <- kernel %||% "gaussian"
+      n_dens <- n_dens %||% 1024
       bounds <- validate_density_bounds(bounds)
 
       data <- ppd_data(ypred)

man-roxygen/args-density-controls.R

@@ -1,4 +1,5 @@
 #' @param bw,adjust,kernel,n_dens,bounds Optional arguments passed to
 #'   [stats::density()] (and `bounds` to [ggplot2::stat_density()]) to override
 #'   default kernel density estimation parameters or truncate the density
-#'   support. `n_dens` defaults to `1024`.
+#'   support. `bw` defaults to `"nrd0"`, `adjust` to `1`, `kernel` to
+#'   `"gaussian"`, and `n_dens` to `1024`.