constant() now returns integer vector always

closes #280

NEWS.md

@@ -8,11 +8,11 @@ In the future:
 Version 0.11 (Released ?)
 ==========================================================
 
-### Breaking Changes
+### Breaking Changes (possible, but unlikely)
 
-* A possible, but unlikely, breaking change is that `kernel_api()` defaults to "text/csv" and UTF-8 encoding.  Formerly, the function would decide on the content-type and encoding.  More details are below in the 'Stability Features' subsection.
+* [`kernel_api()`](https://ouhscbbmc.github.io/REDCapR/reference/kernel_api.html) defaults to "text/csv" and UTF-8 encoding.  Formerly, the function would decide on the content-type and encoding.  More details are below in the 'Stability Features' subsection.
 
-* 
+* [`constant()`](https://ouhscbbmc.github.io/REDCapR/reference/constant.html) no longer accepts `simplify` as an options.  An integer vector is always returned.  (#280)
 
 ### New Features
 

R/constant.R

@@ -6,8 +6,6 @@
 #' @description Collection of constants defined by the REDCap developers.
 #'
 #' @param name Name of constant.  Required character.
-#' @param simplify Simplifies the vector of values to a common data-type,
-#' if possible. Passed to the `simplify` parameter of [base::sapply()].
 #'
 #' @return The constant's value.  Currently all are single integers,
 #'   but that could be expanded in the future.
@@ -101,16 +99,15 @@
 #' }
 
 #' @export
-constant <- function(name, simplify=TRUE) {
+constant <- function(name) {
   checkmate::assert_character(name, any.missing = FALSE, min.chars = 1L)
   checkmate::assert_subset(name, names(constant_list), empty.ok = FALSE)
-  checkmate::assert_logical(simplify, any.missing = FALSE, len = 1L)
 
-  sapply(
+  vapply(
     X         = name,
     FUN       = function(x) constant_list[[x]],
     USE.NAMES = FALSE,
-    simplify  = simplify
+    FUN.VALUE = integer(1)
   )
 }
 

tests/testthat/test-constant.R

@@ -1,26 +1,14 @@
 library(testthat)
 
-test_that("scalar w/ simplify", {
+test_that("scalar", {
   expect_equal(object= constant("form_incomplete"    ), expected=0L)
   expect_equal(object= constant("form_unverified"    ), expected=1L)
   expect_equal(object= constant("form_complete"      ), expected=2L)
 })
 
-test_that("scalar w/o simplify", {
-  expect_equal(object= constant("form_incomplete"    , simplify=TRUE), expected=0L)
-  expect_equal(object= constant("form_unverified"    , simplify=TRUE), expected=1L)
-  expect_equal(object= constant("form_complete"      , simplify=TRUE), expected=2L)
-})
-
-test_that("vector w/ simplify", {
+test_that("vector", {
   expected <- c(2L, 2L, 0L)
-  observed <- constant(c("form_complete", "form_complete", "form_incomplete"), simplify=TRUE)
-  expect_equal(observed, expected)
-})
-
-test_that("vector w/o simplify", {
-  expected <- list(2L, 2L, 0L)
-  observed <- constant(c("form_complete", "form_complete", "form_incomplete"), simplify=FALSE)
+  observed <- constant(c("form_complete", "form_complete", "form_incomplete"))
   expect_equal(observed, expected)
 })
 
@@ -52,28 +40,6 @@ test_that("missing name", {
   )
 })
 
-test_that("bad simplify", {
-  # expected_error_message <- "Assertion on 'simplify' failed: Must be of type 'logical', not 'character'."
-  expect_error(
-    constant("form_complete", simplify="aa"),
-    "^Assertion on 'simplify' failed: Must be of type 'logical', not 'character'\\.$"
-  )
-})
-test_that("missing simplify", {
-  # expected_error_message <- "Assertion on 'simplify' failed: Must be of type 'logical', not 'NULL'. "
-  expect_error(
-    constant("form_complete", simplify=NULL),
-    "^Assertion on 'simplify' failed: Must be of type 'logical', not 'NULL'\\.$"
-  )
-})
-test_that("NA simplify", {
-  # newer version of checkmate: "Assertion on 'simplify' failed: Contains missing values (element 1)."
-  # older version of checkmate: "Assertion on 'simplify' failed: Contains missing values."
-  expect_error(
-    constant("form_complete", simplify=NA_character_),
-    "^Assertion on 'simplify' failed: Contains missing values.*$"
-  )
-})
 
 
 # ---- constant-to-* -----------------------------------------------------------