feat(model): very basic model which generates stroke patient ASU arrivals (with mini run time and no trajectory)

Author: amyheather

DESCRIPTION

@@ -17,6 +17,8 @@ License: MIT + file LICENSE
 Encoding: UTF-8
 LazyData: true
 RoxygenNote: 7.3.2
+Imports:
+    simmer
 Suggests:
     devtools
 Config/testthat/edition: 3

NAMESPACE

@@ -6,4 +6,12 @@ export(create_asu_routing)
 export(create_parameters)
 export(create_rehab_arrivals)
 export(create_rehab_los)
-export(create_rehab_routing)
+export(create_rehab_routing)
+export(model)
+importFrom(simmer,add_generator)
+importFrom(simmer,get_mon_arrivals)
+importFrom(simmer,get_mon_resources)
+importFrom(simmer,simmer)
+importFrom(simmer,timeout)
+importFrom(simmer,trajectory)
+importFrom(simmer,wrap)

R/model.R

@@ -0,0 +1,45 @@
+#' Run simulation.
+#'
+#' @param run_number Integer representing index of current simulation run.
+#' @param param Named list of model parameters.
+#' @param set_seed Whether to set seed within the model function (which we
+#' may not wish to do if being set elsewhere - such as done in runner()).
+#' Default is TRUE.
+#'
+#' @importFrom simmer add_generator get_mon_arrivals get_mon_resources simmer
+#' @importFrom simmer timeout trajectory wrap
+#'
+#' @return TBC
+#' @export
+
+model <- function(run_number, param, set_seed = TRUE) {
+
+  # Set random seed based on run number
+  if (set_seed) {
+    set.seed(run_number)
+  }
+
+  # Create simmer environment
+  env <- simmer("simulation", verbose = TRUE)
+
+  # Define the stroke patient trajectory
+  stroke_patient <- trajectory("stroke_patient_path") |>
+    timeout(1)
+
+  # Add patient generator
+  env <- env |>
+    add_generator("stroke_patient", stroke_patient, function () {
+      rexp(n = 1L, rate = 1L / param[["asu_arrivals"]][["stroke"]])
+    }) |>
+    simmer::run(20) |>
+    wrap()
+
+  # Extract the monitored arrivals and resources information from the simmer
+  # environment object
+  result <- list(
+    arrivals = get_mon_arrivals(env, per_resource = TRUE, ongoing = TRUE),
+    resources = get_mon_resources(env)
+  )
+
+  return(result)
+}

man/create_parameters.Rd

@@ -134,6 +134,16 @@
       ],
       "Hash": "3f038e5ac7f41d4ac41ce658c85e3042"
     },
+    "codetools": {
+      "Package": "codetools",
+      "Version": "0.2-20",
+      "Source": "Repository",
+      "Repository": "CRAN",
+      "Requirements": [
+        "R"
+      ],
+      "Hash": "61e097f35917d342622f21cdc79c256e"
+    },
     "commonmark": {
       "Package": "commonmark",
       "Version": "1.9.2",
@@ -988,6 +998,20 @@
       ],
       "Hash": "011db3556755012e632ed99d083d7d75"
     },
+    "simmer": {
+      "Package": "simmer",
+      "Version": "4.4.7",
+      "Source": "Repository",
+      "Repository": "CRAN",
+      "Requirements": [
+        "R",
+        "Rcpp",
+        "codetools",
+        "magrittr",
+        "utils"
+      ],
+      "Hash": "6e993f252a8a2a7bf19856c82af1414b"
+    },
     "sourcetools": {
       "Package": "sourcetools",
       "Version": "0.1.7-1",

man/create_rehab_routing.Rd

@@ -12,5 +12,5 @@ library(simulation)
 ```
 
 ```{r}
-create_parameters()
+model(run_number = 1L, param = create_parameters(), set_seed = TRUE)
 ```