add notation argument to limits_to_agegroups()

NEWS.md

@@ -3,6 +3,7 @@
 * The speed of loading surveys has been increased.
 * An error has been fixed causing NA contact matrices if any 5-year age band in the population data was missing.
 * Results of function calls accessing Zenodo repository are now cached for speedup and to avoid multiple web requests
+* The `limits_to_agegroups` has been changed to return bracket notated age ranges by default
 
 # socialmixr 0.3.2
 

R/limits_to_agegroups.r

@@ -3,20 +3,37 @@
 #' Mostly used for plot labelling
 #' @param x age limits to transform
 #' @param limits lower age limits; if not given, will use all limits in `x`
-#' @return Age groups (limits separated by dashes)
+#' @param notation whether to use bracket notation, e.g. [0,4) or dash
+#'   notation, e.g. 0-4)
+#' @return Age groups as specified in `notation`
 #' @examples
 #' limits_to_agegroups(c(0, 5, 10))
 #' @export
-limits_to_agegroups <- function(x, limits = sort(unique(x))) {
+limits_to_agegroups <- function(x, limits = sort(unique(x)),
+                                notation = c("dashes", "brackets")) {
+  if (missing(notation)) {
+    warning(
+      "In the next version of socialmixr the default notation will ",
+      "become \"brackets\" instead of \"dashes\". To prevent this, ",
+      "use `notation = \"dashes\"` in the call to `limits_to_agegroups()`."
+    )
+  }
+  notation <- match.arg(notation)
   limits <- limits[!is.na(limits)]
   agegroups <- if (length(limits) > 1) {
-    vapply(seq(1, length(limits) - 1), function(y) {
-      if ((limits[y + 1] - 1) > limits[y]) {
-        paste(limits[y], limits[y + 1] - 1, sep = "-")
-      } else {
-        paste(limits[y])
-      }
-    }, "")
+    if (notation == "brackets") {
+      vapply(seq(1, length(limits) - 1), function(y) {
+        paste0("[", limits[y], ",", limits[y + 1], ")")
+      }, "")
+    } else if (notation == "dashes") {
+      vapply(seq(1, length(limits) - 1), function(y) {
+        if ((limits[y + 1] - 1) > limits[y]) {
+          paste(limits[y], limits[y + 1] - 1, sep = "-")
+        } else {
+          paste(limits[y])
+        }
+      }, "")
+    }
   } else {
     NULL
   }

tests/testthat/test-agegroups.r

@@ -4,9 +4,17 @@
   ages <- seq_len(50)
   age_limits <- c(0, 5, 10)
   groups <- reduce_agegroups(ages, age_limits)
-  expect_length(unique(groups), 3)
-  age_groups <- limits_to_agegroups(groups)
-  expect_length(unique(age_groups), 3)
+  expect_equal(unique(groups), age_limits)
+  expect_warning(limits_to_agegroups(groups), "default")
+  age_groups <-
+  expect_equal(
+    as.character(unique(limits_to_agegroups(groups, notation = "brackets"))),
+    c("[0,5)", "[5,10)", "10+")
+  )
+  expect_equal(
+    as.character(unique(limits_to_agegroups(groups, notation = "dashes"))),
+    c("0-4", "5-9", "10+")
+  )
 })
 
 test_that("age groups are ordered factors", {