chore(docstrings): corrections to the create_..._trajectory and sample_routing docstrings

Author: amyheather

R/create_asu_trajectory.R

@@ -5,7 +5,7 @@
 #' parameter is used.
 #' @param param Nested list containing simulation parameters. Must have
 #' structure `param$asu_routing$<patient_type>` containing the probability of
-#' routing to each destination (e.g.`param$asu_routing_stroke$rehab = 0.24`).
+#' routing to each destination (e.g.`param$asu_routing$stroke$rehab = 0.24`).
 #'
 #' @importFrom simmer trajectory
 #'

R/create_rehab_trajectory.R

@@ -4,8 +4,8 @@
 #' one of: "stroke", "tia", "neuro", or "other". Determines which arrival rate
 #' parameter is used.
 #' @param param Nested list containing simulation parameters. Must have
-#' structure `param$asu_routing$<patient_type>` containing the probability of
-#' routing to each destination (e.g.`param$asu_routing_stroke$rehab = 0.24`).
+#' structure `param$rehab_routing$<patient_type>` containing the probability of
+#' routing to each destination (e.g.`param$rehab_routing$stroke$esd = 0.40`).
 #'
 #' @importFrom simmer trajectory
 #'

R/sample_routing.R

@@ -1,13 +1,14 @@
 #' Sample a destination based on probabilities
 #'
 #' Randomly selects a destination from a list, where each destination has an
-#' associated probability.
+#' associated probability. The destination is returned as a numeric index, as
+#' `simmer::set_attribute()` requires a numeric or function.
 #'
 #' @param prob_list Named list. The names are destination labels (character),
 #' and the values are their corresponding probabilities (numeric, non-negative,
 #' sum to 1).
 #'
-#' @return A character string. The name of the selected destination.
+#' @return An integer. The index of the selected destination within `prob_list`.
 #' @export
 
 sample_routing <- function(prob_list) {