feat(logs): add custom logs (as felt this would particularly benefit, as the default are so hard to read, and I wanted to be sure everything was set up right - which it looks to be!) :)

Author: amyheather

NAMESPACE

@@ -18,10 +18,12 @@ importFrom(simmer,branch)
 importFrom(simmer,get_attribute)
 importFrom(simmer,get_mon_arrivals)
 importFrom(simmer,get_mon_resources)
+importFrom(simmer,log_)
 importFrom(simmer,set_attribute)
 importFrom(simmer,simmer)
 importFrom(simmer,timeout)
 importFrom(simmer,trajectory)
 importFrom(simmer,wrap)
 importFrom(stats,rexp)
 importFrom(stats,rlnorm)
+importFrom(utils,capture.output)

R/create_asu_trajectory.R

@@ -13,7 +13,7 @@
 #' of routing to each destination (e.g.
 #' \code{param$asu_routing$stroke$rehab = 0.24}).
 #'
-#' @importFrom simmer branch trajectory
+#' @importFrom simmer branch get_attribute log_ set_attribute timeout trajectory
 #' @importFrom stats rlnorm
 #'
 #' @return Simmer trajectory object. Defines patient journey logic through the
@@ -25,13 +25,23 @@ create_asu_trajectory <- function(env, patient_type, param) {
   # Set up simmer trajectory object...
   trajectory(paste0("ASU_", patient_type, "_path")) |>
 
+    log_("🚶 Arrived at ASU") |>
+
     # Sample destination after ASU (as destination influences length of stay)
     set_attribute("post_asu_destination", function() {
       sample_routing(prob_list = param[["asu_routing"]][[patient_type]])
     }) |>
 
-    timeout(function() {
+    log_(function() {
+      # Retrieve attribute, and use to get post-ASU destination as a string
+      dest_index <- get_attribute(env, "post_asu_destination")
+      dest_names <- names(param[["asu_routing"]][[patient_type]])
+      dest <- dest_names[dest_index]
+      # Create log message
+      paste0("🎯 Planned ASU -> ", dest_index, " (", dest, ")")
+    }) |>
 
+    set_attribute("asu_los", function() {
       # Retrieve attribute, and use to get post-ASU destination as a string
       dest_index <- get_attribute(env, "post_asu_destination")
       dest_names <- names(param[["asu_routing"]][[patient_type]])
@@ -59,6 +69,15 @@ create_asu_trajectory <- function(env, patient_type, param) {
       )
     }) |>
 
+    log_(function() {
+      paste0("⏳ ASU length of stay: ",
+             round(get_attribute(env, "asu_los"), 3L))
+    }) |>
+
+    timeout(function() get_attribute(env, "asu_los")) |>
+
+    log_("🏁 ASU stay completed") |>
+
     # If that patient's destination is rehab, then start on that trajectory
     branch(
       option = function() {

R/create_rehab_trajectory.R

@@ -13,7 +13,7 @@
 #' probability of routing to each destination (e.g.
 #' \code{param$rehab_routing$stroke$esd = 0.40}).
 #'
-#' @importFrom simmer trajectory
+#' @importFrom simmer get_attribute log_ set_attribute timeout trajectory
 #' @importFrom stats rlnorm
 #'
 #' @return Simmer trajectory object. Defines patient journey logic through the
@@ -25,13 +25,23 @@ create_rehab_trajectory <- function(env, patient_type, param) {
   # Set up simmer trajectory object...
   trajectory(paste0("rehab_", patient_type, "_path")) |>
 
+    log_("🚶 Arrived at rehab") |>
+
     # Sample destination after rehab (as destination influences length of stay)
     set_attribute("post_rehab_destination", function() {
       sample_routing(prob_list = param[["rehab_routing"]][[patient_type]])
     }) |>
 
-    timeout(function() {
+    log_(function() {
+      # Retrieve attribute, and use to get post-rehab destination as a string
+      dest_index <- get_attribute(env, "post_rehab_destination")
+      dest_names <- names(param[["rehab_routing"]][[patient_type]])
+      dest <- dest_names[dest_index]
+      # Create log message
+      paste0("🎯 Planned rehab -> ", dest_index, " (", dest, ")")
+    }) |>
 
+    set_attribute("rehab_los", function() {
       # Retrieve attribute, and use to get post-rehab destination as a string
       dest_index <- get_attribute(env, "post_rehab_destination")
       dest_names <- names(param[["rehab_routing"]][[patient_type]])
@@ -56,5 +66,14 @@ create_rehab_trajectory <- function(env, patient_type, param) {
         meanlog = los_params[["meanlog"]],
         sdlog = los_params[["sdlog"]]
       )
-    })
+    }) |>
+
+    log_(function() {
+      paste0("⏳ Rehab length of stay: ",
+             round(get_attribute(env, "rehab_los"), 3L))
+    }) |>
+
+    timeout(function() get_attribute(env, "rehab_los")) |>
+
+    log_("🏁 Rehab stay completed")
 }

R/model.R

@@ -26,8 +26,8 @@ model <- function(run_number, param, set_seed = TRUE) {
   param[["asu_los_lnorm"]] <- transform_to_lnorm(param[["asu_los"]])
   param[["rehab_los_lnorm"]] <- transform_to_lnorm(param[["rehab_los"]])
 
-  # Create simmer environment
-  env <- simmer("simulation", verbose = verbose)
+  # Create simmer environment - set verbose to FALSE as using custom logs
+  env <- simmer("simulation", verbose = FALSE)
 
   # Add ASU and rehab direct admission patient generators
   for (unit in c("asu", "rehab")) {
@@ -42,7 +42,7 @@ model <- function(run_number, param, set_seed = TRUE) {
 
       # Add patient generator using the created trajectory
       sim_log <- capture.output(
-        env <- add_patient_generator(
+        env <- add_patient_generator( # nolint
           env = env,
           trajectory = traj,
           unit = unit,
@@ -55,7 +55,7 @@ model <- function(run_number, param, set_seed = TRUE) {
 
   # Run the model
   sim_log <- capture.output(
-    env <- env |>
+    env <- env |> # nolint
       simmer::run(20L) |>
       wrap()
   )