Deprecate grid_lines(size) instead of removing it

grid_lines() is exported, so we can't just drop the size
parameter without breaking user code. Keep it with a
lifecycle deprecation warning pointing to linewidth.

Also adds lifecycle as an imported dependency and updates
the test to use linewidth.

Author: ishaan-arora-1

DESCRIPTION

@@ -34,6 +34,7 @@ Imports:
     ggplot2 (>= 3.4.0),
     ggridges (>= 0.5.5),
     glue,
+    lifecycle,
     posterior,
     reshape2,
     rlang (>= 0.3.0),

NAMESPACE

@@ -226,3 +226,6 @@ importFrom(dplyr,top_n)
 importFrom(dplyr,ungroup)
 importFrom(dplyr,vars)
 importFrom(ggplot2,"%+replace%")
+importFrom(lifecycle,deprecate_warn)
+importFrom(lifecycle,deprecated)
+importFrom(lifecycle,is_present)

R/bayesplot-helpers.R

@@ -447,8 +447,17 @@ plot_bg <- function(on = TRUE, ...) {
 #' @rdname bayesplot-helpers
 #' @export
 #' @param color,linewidth Passed to [ggplot2::element_line()].
-#'
-grid_lines <- function(color = "gray50", linewidth = 0.2) {
+#' @param size `r lifecycle::badge("deprecated")` Use `linewidth` instead.
+#'
+grid_lines <- function(color = "gray50", linewidth = 0.2, size = deprecated()) {
+  if (lifecycle::is_present(size)) {
+    lifecycle::deprecate_warn(
+      "1.16.0",
+      "grid_lines(size)",
+      "grid_lines(linewidth)"
+    )
+    linewidth <- size
+  }
   theme(
     panel.grid.major = element_line(color = color, linewidth = linewidth),
     panel.grid.minor = element_line(color = color, linewidth = linewidth * 0.5)

R/bayesplot-package.R

@@ -5,6 +5,7 @@
 #'
 #' @import ggplot2 stats rlang
 #' @importFrom dplyr %>% summarise group_by select
+#' @importFrom lifecycle deprecated deprecate_warn is_present
 #'
 #' @description
 #' \if{html}{

man/bayesplot-helpers.Rd

@@ -63,7 +63,7 @@ test_that("lbub works", {
 
 # plot and facet backgrounds ----------------------------------------------
 test_that("grid_lines returns correct theme object", {
-  thm <- theme_default() + grid_lines(size = 1.5, color = "purple")
+  thm <- theme_default() + grid_lines(linewidth = 1.5, color = "purple")
   expect_equal(thm$panel.grid.major, element_line(linewidth = 1.5, color = "purple"))
   expect_equal(thm$panel.grid.minor, element_line(linewidth = 0.75, color = "purple"))
 })