Change 'border' parameter to 'grid'

amices · Dec 14, 2023 · 62e2925 · 62e2925
1 parent aa28c98
commit 62e2925
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 6 deletions.
diff --git a/R/plot_miss.R b/R/plot_miss.R
@@ -2,7 +2,7 @@
 #'
 #' @param data An incomplete dataset of class `data.frame` or `matrix`.
 #' @param vrb String, vector, or unquoted expression with variable name(s), default is "all".
-#' @param border Logical indicating whether borders should be present between tiles.
+#' @param grid Logical indicating whether borders should be present between tiles.
 #' @param ordered Logical indicating whether rows should be ordered according to their pattern.
 #' @param square  Logical indicating whether the plot tiles should be squares, defaults to squares.
 #'
@@ -15,7 +15,7 @@
 plot_miss <-
   function(data,
            vrb = "all",
-           border = FALSE,
+           grid = FALSE,
            square = FALSE,
            ordered = FALSE) {
     # input processing
@@ -103,7 +103,7 @@ plot_miss <-
       ) +
       theme_minimice()
     # additional arguments
-    if (border) {
+    if (grid) {
       gg <- gg + ggplot2::geom_tile(color = "black")
     } else{
       gg <- gg + ggplot2::geom_tile()

diff --git a/man/plot_miss.Rd b/man/plot_miss.Rd
diff --git a/tests/testthat/test-plot_miss.R.R → tests/testthat/test-plot_miss.R b/tests/testthat/test-plot_miss.R.R → tests/testthat/test-plot_miss.R
@@ -4,7 +4,7 @@ dat <- mice::nhanes
 # tests
 test_that("plot_miss produces plot", {
   expect_s3_class(plot_miss(dat), "ggplot")
-  expect_s3_class(plot_miss(dat, border = TRUE, ordered = TRUE, square = TRUE), "ggplot")
+  expect_s3_class(plot_miss(dat, grid = TRUE, ordered = TRUE, square = TRUE), "ggplot")
   expect_s3_class(plot_miss(cbind(dat, "testvar" = NA)), "ggplot")
 })