Closes #2001 Added processing for missing age_units in compute_age_years

NEWS.md

@@ -4,6 +4,7 @@
 
 ## Updates of Existing Functions
 - The functions `derive_param_bmi()` and `derive_param_bsa()` are updated to have the option of producing more values at visits when only weight is collected (#1228).
+- The functions `derive_var_age_years` and `compute_age_years` are updated to return an `NA` age in the case that the age unit is missing (#2001).
 
 ## Breaking Changes
 - The following functions, which were deprecated in previous `{admiral}` versions, have been removed: (#1950)

R/compute_age_years.R

@@ -14,10 +14,12 @@
 #'   as `"years"` and `"Years"`).
 #'
 #'   Permitted Values: `"years"`, `"months"`, `"weeks"`, `"days"`, `"hours"`, `"minutes"`,
-#'   `"seconds"`.
+#'   `"seconds", NA_character_`.
 #'
-#' @details Returns a numeric vector of ages in years as doubles. Note, underlying
-#' computations assume an equal number of days in each year (365.25).
+#' @details Returns a numeric vector of ages in years as doubles. Note
+#' that passing `NA_character_` as a unit will result in an `NA` value for the outputted
+#' age. Also note, underlying computations assume an equal number of days in each
+#' year (365.25).
 #'
 #' @return The ages contained in `age` converted to years.
 #'
@@ -34,8 +36,8 @@
 #' )
 #'
 #' compute_age_years(
-#'   age = c(10, 520, 3650),
-#'   age_unit = c("YEARS", "WEEKS", "DAYS")
+#'   age = c(10, 520, 3650, 1000),
+#'   age_unit = c("YEARS", "WEEKS", "DAYS", NA_character_)
 #' )
 #'
 compute_age_years <- function(age,
@@ -57,6 +59,13 @@ compute_age_years <- function(age,
     ))
   }
 
+  for (i in seq_along(age_unit)) {
+    if (is.na(age_unit[i])) {
+      age[i] <- NA
+      age_unit[i] <- "years"
+    }
+  }
+
   age_years <- time_length(
     duration(age,
       units = tolower(age_unit)

tests/testthat/test-compute_age_years.R

@@ -16,10 +16,10 @@ test_that("compute_age_years Test 1: compute_age_years() works when `age_unit` i
 
 ## Test 2: compute_age_years() works when `age_unit` is a vector ----
 test_that("compute_age_years Test 2: compute_age_years() works when `age_unit` is a vector", {
-  age_input <- c(28, 1461, 10227)
-  age_unit_input <- c("YEARS", "WEEKS", "DAYS")
+  age_input <- c(28, 1461, 10227, 32)
+  age_unit_input <- c("YEARS", "WEEKS", "DAYS", NA_character_)
 
-  expected_output <- rep(28, 3)
+  expected_output <- c(28, 28, 28, NA)
 
   expect_equal(
     compute_age_years(