Merge pull request #556 from yjunechoe/remove-na-snip_list

Add `snip_list(na_rm)` argument

R/info_add.R

@@ -1231,6 +1231,12 @@ info_snippet <- function(
 #'   derived from `character` or `factor` values; numbers, dates, and logical
 #'   values won't have quotation marks. We can explicitly use quotations (or
 #'   not) with either `TRUE` or `FALSE` here.
+#'   
+#' @param na_rm *Remove NA values from list*
+#' 
+#'   `scalar<logical>` // *default:* `FALSE`
+#' 
+#'   An option for whether NA values should be counted as an item in the list.
 #' 
 #' @param lang *Reporting language*
 #' 
@@ -1301,6 +1307,7 @@ snip_list <- function(
     oxford = TRUE,
     as_code = TRUE,
     quot_str = NULL,
+    na_rm = FALSE,
     lang = NULL
 ) {
 
@@ -1376,6 +1383,7 @@ snip_list <- function(
             oxford = <<oxford>>,
             as_code = <<as_code>>,
             quot_str = <<quot_str>>,
+            na_rm = <<na_rm>>,
             lang = <<lang>>
           )",
           .open = "<<", .close = ">>"   
@@ -1406,6 +1414,7 @@ snip_list <- function(
             oxford = <<oxford>>,
             as_code = <<as_code>>,
             quot_str = <<quot_str>>,
+            na_rm = <<na_rm>>,
             lang = <<lang>>
           )",
           .open = "<<", .close = ">>"   
@@ -1435,6 +1444,7 @@ snip_list <- function(
             oxford = <<oxford>>,
             as_code = <<as_code>>,
             quot_str = <<quot_str>>,
+            na_rm = <<na_rm>>,
             lang = <<lang>>
           )",
           .open = "<<", .close = ">>"   

R/utils.R

@@ -1221,11 +1221,16 @@ pb_str_catalog <- function(
     oxford = TRUE,
     as_code = TRUE,
     quot_str = NULL,
+    na_rm = FALSE,
     lang = NULL
 ) {
 
   if (is.null(lang)) lang <- "en"
 
+  if (na_rm) {
+    item_vector <- item_vector[!is.na(item_vector)]
+  }
+
   item_count <- length(item_vector)
 
   # If there is nothing in the `item_vector`, return

tests/testthat/test-snip_fns.R

@@ -511,6 +511,30 @@ test_that("the `snip_list()` function works", {
       small_table
     )
   )
+
+  # na_rm ignores NA values in list
+  expect_match(
+    run_snip(
+      snip_list(column = "f", na_rm = FALSE),
+      small_table %>% dplyr::mutate(f = ifelse(f == "high", NA, f))
+    ),
+    "NA"
+  )
+  expect_no_match(
+    run_snip(
+      snip_list(column = "f", na_rm = TRUE),
+      small_table %>% dplyr::mutate(f = ifelse(f == "high", NA, f))
+    ),
+    "NA"
+  )
+  expect_equal(
+    run_snip(
+      snip_list(column = "f", na_rm = TRUE),
+      small_table %>% dplyr::mutate(f = NA)
+    ),
+    "---"
+  )
+
 })
 
 test_that("the `snip_stats()` function works", {