Simplify diagnostic scale naming to neff_ratio

Author: utkarshpawade

NEWS.md

@@ -10,7 +10,7 @@
 * 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)
-* Make diagnostic color scale helpers handle `"neff"` and `"neff_ratio"` explicitly, avoiding reliance on partial matching.
+* Use `"neff_ratio"` consistently in diagnostic color scale helpers to avoid relying on partial matching of `"neff"`.
 
 # bayesplot 1.15.0
 

R/mcmc-diagnostics.R

@@ -255,8 +255,8 @@ mcmc_neff <- function(ratio, ..., size = NULL) {
       linetype = 2,
       linewidth = 0.25) +
     labs(y = NULL, x = expression(N[eff]/N)) +
-    scale_fill_diagnostic("neff") +
-    scale_color_diagnostic("neff") +
+    scale_fill_diagnostic("neff_ratio") +
+    scale_color_diagnostic("neff_ratio") +
     scale_x_continuous(
       breaks = breaks,
       # as.character truncates trailing zeroes, while ggplot default does not
@@ -287,8 +287,8 @@ mcmc_neff_hist <- function(ratio, ..., binwidth = NULL, bins = NULL, breaks = NU
       binwidth = binwidth,
       bins = bins,
       breaks = breaks) +
-    scale_color_diagnostic("neff") +
-    scale_fill_diagnostic("neff") +
+    scale_color_diagnostic("neff_ratio") +
+    scale_fill_diagnostic("neff_ratio") +
     labs(x = expression(N[eff]/N), y = NULL) +
     dont_expand_y_axis(c(0.005, 0)) +
     yaxis_title(FALSE) +
@@ -424,27 +424,19 @@ diagnostic_points <- function(size = NULL) {
 
 # Functions wrapping around scale_color_manual() and scale_fill_manual(), used to
 # color the intervals by rhat value
-scale_color_diagnostic <- function(diagnostic = c("rhat", "neff")) {
-  d <- match.arg(diagnostic, choices = c("rhat", "neff", "neff_ratio"))
+scale_color_diagnostic <- function(diagnostic = c("rhat", "neff_ratio")) {
+  d <- match.arg(diagnostic)
   diagnostic_color_scale(d, aesthetic = "color")
 }
 
-scale_fill_diagnostic <- function(diagnostic = c("rhat", "neff")) {
-  d <- match.arg(diagnostic, choices = c("rhat", "neff", "neff_ratio"))
+scale_fill_diagnostic <- function(diagnostic = c("rhat", "neff_ratio")) {
+  d <- match.arg(diagnostic)
   diagnostic_color_scale(d, aesthetic = "fill")
 }
 
-normalize_diagnostic_name <- function(diagnostic) {
-  diagnostic <- match.arg(diagnostic, choices = c("rhat", "neff", "neff_ratio"))
-  if (diagnostic == "neff") {
-    diagnostic <- "neff_ratio"
-  }
-  diagnostic
-}
-
 diagnostic_color_scale <- function(diagnostic = c("rhat", "neff_ratio"),
                                    aesthetic = c("color", "fill")) {
-  diagnostic <- normalize_diagnostic_name(diagnostic)
+  diagnostic <- match.arg(diagnostic)
   aesthetic <- match.arg(aesthetic)
   dc <- diagnostic_colors(diagnostic, aesthetic)
   do.call(
@@ -460,7 +452,7 @@ diagnostic_color_scale <- function(diagnostic = c("rhat", "neff_ratio"),
 
 diagnostic_colors <- function(diagnostic = c("rhat", "neff_ratio"),
                               aesthetic = c("color", "fill")) {
-  diagnostic <- normalize_diagnostic_name(diagnostic)
+  diagnostic <- match.arg(diagnostic)
   aesthetic <- match.arg(aesthetic)
   color_levels <- c("light", "mid", "dark")
   if (diagnostic == "neff_ratio") {

tests/testthat/test-mcmc-diagnostics.R

@@ -79,28 +79,10 @@ test_that("'description' & 'rating' columns are correct (#176)", {
   expect_equal(df$description, expected_descriptions)
 })
 
-test_that("diagnostic color helpers handle neff names explicitly", {
-  # wrappers accept both aliases
-  expect_no_error(scale_color_diagnostic("neff"))
-  expect_no_error(scale_fill_diagnostic("neff"))
+test_that("diagnostic color helpers use neff_ratio consistently", {
   expect_no_error(scale_color_diagnostic("neff_ratio"))
   expect_no_error(scale_fill_diagnostic("neff_ratio"))
-
-  # aliases map to equivalent scales
-  color_neff <- scale_color_diagnostic("neff")
-  color_neff_ratio <- scale_color_diagnostic("neff_ratio")
-  expect_equal(color_neff$palette(3), color_neff_ratio$palette(3))
-  expect_equal(color_neff$labels, color_neff_ratio$labels)
-
-  fill_neff <- scale_fill_diagnostic("neff")
-  fill_neff_ratio <- scale_fill_diagnostic("neff_ratio")
-  expect_equal(fill_neff$palette(3), fill_neff_ratio$palette(3))
-  expect_equal(fill_neff$labels, fill_neff_ratio$labels)
-
-  base_neff <- diagnostic_color_scale("neff", aesthetic = "color")
-  base_neff_ratio <- diagnostic_color_scale("neff_ratio", aesthetic = "color")
-  expect_equal(base_neff$palette(3), base_neff_ratio$palette(3))
-  expect_equal(base_neff$labels, base_neff_ratio$labels)
+  expect_no_error(diagnostic_color_scale("neff_ratio", aesthetic = "color"))
 })
 
 test_that("mcmc_acf & mcmc_acf_bar return a ggplot object", {