Merge pull request #101 from cmu-delphi/lcb/allow-timeset-star-again

Allow "*" as a timeset, update roxygen, tests

Author: dshemetov

R/model.R

@@ -55,9 +55,12 @@ epirange <- function(from, to) {
 #'   YYYYMMDD,
 #' - Epiweeks: integer-like values or integer-like strings that take the form YYYYMM,
 #' - EpiRanges: a list of [`epirange`] instances.
+#' - Wildcard: "*" (requests all available values for this dimension)
 #'
-#' Please refer to the specific endpoint documentation for guidance on using dates vs weeks. Most
-#' endpoints support only one or the other.
+#' Please refer to the specific endpoint documentation for guidance on using
+#' dates vs weeks. Most endpoints support only one or the other. Some (less
+#' commonly used) endpoints may not accept the `"*"` wildcard, but this can be
+#' simulated with a large [`epirange`].
 #'
 #' @name timeset
 NULL
@@ -176,7 +179,9 @@ parse_timeset_input <- function(value) {
       stop(paste0("Invalid timeset input: ", value))
     }
   } else if (test_character(value)) {
-    if (all(nchar(value) %in% c(6, 8))) {
+    if (identical(value, "*")) {
+      return(value)
+    } else if (all(nchar(value) %in% c(6, 8))) {
       return(value)
     } else if (all(nchar(value) == 10)) {
       value <- as.Date(value, format = "%Y-%m-%d")

man/timeset.Rd

@@ -32,6 +32,7 @@ test_that("assert_date_param", {
 })
 
 test_that("assert_timeset_param", {
+  # Make sure to keep in sync with test-model.R parse_timeset_input checks
   expect_no_error(assert_timeset_param("name", "*"))
   expect_no_error(assert_timeset_param("name", "2020-01-01", len = 1))
   expect_error(assert_timeset_param("name", c("2020-01-01", "2021-01-02"), len = 1))
@@ -43,4 +44,7 @@ test_that("assert_timeset_param", {
   expect_error(assert_timeset_param("name", NULL))
   expect_no_error(assert_timeset_param("name", NULL, required = FALSE))
   expect_error(assert_timeset_param("name", list(epirange(20200101, 20200102), epirange(20200101, 20200102))))
+  # Non-EpiRange-class epiranges are no longer allowed:
+  expect_error(assert_timeset_param("name", list(from = "2020-01-01", to = "2021-01-02")))
+  expect_error(assert_timeset_param("name", c(from = "2020-01-01", to = "2021-01-02")))
 })

tests/testthat/test-check.R

@@ -8,4 +8,5 @@ test_that("epirange", {
   expect_error(epirange(1, 2))
   expect_error(epirange("1", "2"))
   expect_error(epirange(201501, 20160101))
+  expect_error(epirange(epirange(201501, 201502), epirange(201601, 201602)))
 })

tests/testthat/test-epirange.R

@@ -0,0 +1,48 @@
+test_that("`parse_timeset_input` on valid inputs", {
+  # Date-like: we can get out Date vector, or character or integerish YYYYmmdd
+  #            format only
+  expect_identical(
+    parse_timeset_input(as.Date("2018-01-01")),
+    as.Date("2018-01-01")
+  )
+  expect_identical(
+    parse_timeset_input(as.Date(c("2018-01-01", "2018-01-02"))),
+    as.Date(c("2018-01-01", "2018-01-02"))
+  )
+  expect_identical(parse_timeset_input("2018-01-01"), "20180101")
+  expect_identical(
+    parse_timeset_input(c("2018-01-01", "2018-01-02")),
+    c("20180101", "20180102")
+  )
+  expect_identical(parse_timeset_input("20180101"), "20180101")
+  expect_identical(
+    parse_timeset_input(c("20180101", "20180102")),
+    c("20180101", "20180102")
+  )
+  expect_identical(parse_timeset_input(20180101), 20180101)
+  expect_identical(
+    parse_timeset_input(c(20180101, 20180102)),
+    c(20180101, 20180102)
+  )
+  # Epiweeks: we can get out character or integerish
+  expect_identical(parse_timeset_input("201801"), "201801")
+  expect_identical(
+    parse_timeset_input(c("201801", "201802")),
+    c("201801", "201802")
+  )
+  expect_identical(parse_timeset_input(201801), 201801)
+  expect_identical(
+    parse_timeset_input(c(201801, 201802)),
+    c(201801, 201802)
+  )
+  # EpiRanges: aren't changed
+  expect_identical(
+    epirange(as.Date("2018-01-01"), as.Date("2018-01-05")),
+    epirange(as.Date("2018-01-01"), as.Date("2018-01-05"))
+  )
+  expect_identical(epirange(201801, 201805), epirange(201801, 201805))
+  # Wildcard:
+  expect_identical(parse_timeset_input("*"), "*")
+  # NULL: allow this as a missing argument marker
+  expect_identical(parse_timeset_input(NULL), NULL)
+})