Export the run_resumable_simulation

Fixes #314
mrc-ide · Jul 3, 2024 · 91f8270 · 91f8270
1 parent 3ecb72a
commit 91f8270
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 0 deletions.
diff --git a/NAMESPACE b/NAMESPACE
@@ -16,6 +16,7 @@ export(peak_season_offset)
 export(rtss_booster_profile)
 export(rtss_profile)
 export(run_metapop_simulation)
+export(run_resumable_simulation)
 export(run_simulation)
 export(run_simulation_with_repetitions)
 export(set_antimalarial_resistance)

diff --git a/R/model.R b/R/model.R
@@ -101,6 +101,7 @@ run_simulation <- function(
 #' @param restore_random_state if TRUE, restore the random number generator's state from the checkpoint.
 #' @return a list with two entries, one for the dataframe of results and one for the final
 #' simulation state.
+#' @export
 run_resumable_simulation <- function(
     timesteps,
     parameters = NULL,

diff --git a/_pkgdown.yml b/_pkgdown.yml
@@ -48,6 +48,7 @@ reference:
     - run_simulation
     - run_metapop_simulation
     - run_simulation_with_repetitions
+    - run_resumable_simulation
 - title: "Parameter functions"
   contents:
     - get_parameters