Add test for print msg for timing variables

Author: RhysPeploe

NEWS.md

@@ -1,6 +1,7 @@
 # iddoverse 0.9.0
 * create_participant_table: baseline timing EPOCH == BASELINE then VISITDY == 1, change from any of VISITDY == 1, DY == 1 and EPOCH == BASELINE
 * prepare_domain: data first, domain second in parameter order to align with tidy principles, changes to downstream functions, examples, documentation, tests and vignette
+* prepare_domain: added a print message describing the timing variables used in console
 * table_variables: data first, domain second in parameter order to align with tidy principles
 * prepare_domain: default timing changed to HR, DY, STDY, CDSTDY, VISITDY, EPOCH (removed VISIT, VISITNUM, EVLINT, EVLINTX)
 * hexsticker logo includes package name

R/prepare_domain.R

@@ -66,7 +66,7 @@ prepare_domain <- function(data, domain,
 
   event_domains <- c("SA", "HO", "ER", "PO")
 
-  # "DS" dealt with unique
+  # "DS" dealt with uniquely
 
   domain <- str_to_upper(domain)
 
@@ -76,6 +76,12 @@ prepare_domain <- function(data, domain,
 
   timing_variables <- timing_variables[which(timing_variables %in% names(data))]
 
+  if(print_messages == TRUE){
+    if(domain != "DM"){
+      print(str_c("The timing variable(s) hierarchy being used in prepare_domain() for the ", domain, " domain are: ", str_flatten(timing_variables, collapse = ", ")))
+    }
+  }
+
   if(include_LOC == TRUE & !(str_c(domain, "LOC") %in% names(data))){
     rlang::warn(str_c("This dataset does not have a location (", domain, "LOC) variable, yet include_LOC is TRUE"))
     include_LOC = FALSE

tests/testthat/test-prepare_domain.R

@@ -221,6 +221,8 @@ test_that("check print_messages parameter option", {
 
   expect_output(prepare_domain(sa, "SA", variables_include = c("FEVER"), print_messages = TRUE),
                  regexp = "Number of rows where values_fn has been used to pick record")
+  expect_output(prepare_domain(sa, "SA", variables_include = c("FEVER"), print_messages = TRUE),
+                regexp = "The timing variable")
 })
 
 test_that("prepare_domain errors when required STUDYID or USUBJID missing", {