Update how seeds are handled (#29)

* Update how seeds are handled * Updating docs
UofUEpiBio · Nov 4, 2024 · 7d7b180 · 7d7b180
1 parent 971d4f3
commit 7d7b180
Show file tree

Hide file tree

Showing 24 changed files with 194 additions and 193 deletions.
diff --git a/R/model-methods.R b/R/model-methods.R
@@ -17,7 +17,7 @@ stopifnot_model <- function(model) {
 #'
 #' @param x An object of class `epiworld_model`.
 #' @param ndays Number of days (steps) of the simulation.
-#' @param seed Seed to set for initializing random number generator.
+#' @param seed Seed to set for initializing random number generator (passed to [set.seed()]).
 #' @param model Model object.
 #' @export
 #' @name epiworld-methods
@@ -157,11 +157,12 @@ verbose_on.epiworld_model <- function(x) {
 #' @returns
 #' - The `run` function returns the simulated model of class `epiworld_model`.
 #' @rdname epiworld-methods
-run <- function(model, ndays, seed = sample.int(1e4, 1)) UseMethod("run")
+run <- function(model, ndays, seed = NULL) UseMethod("run")
 
 #' @export
-run.epiworld_model <- function(model, ndays, seed = sample.int(1e4, 1)) {
-  run_cpp(model, ndays, seed)
+run.epiworld_model <- function(model, ndays, seed = NULL) {
+  if (length(seed)) set.seed(seed)
+  run_cpp(model, ndays, sample.int(1e4, 1))
   invisible(model)
 }
 

diff --git a/man/ModelDiffNet.Rd b/man/ModelDiffNet.Rd
diff --git a/man/ModelSEIR.Rd b/man/ModelSEIR.Rd
diff --git a/man/ModelSEIRCONN.Rd b/man/ModelSEIRCONN.Rd
diff --git a/man/ModelSEIRD.Rd b/man/ModelSEIRD.Rd
diff --git a/man/ModelSEIRDCONN.Rd b/man/ModelSEIRDCONN.Rd
diff --git a/man/ModelSIR.Rd b/man/ModelSIR.Rd
diff --git a/man/ModelSIRCONN.Rd b/man/ModelSIRCONN.Rd
diff --git a/man/ModelSIRD.Rd b/man/ModelSIRD.Rd
diff --git a/man/ModelSIRDCONN.Rd b/man/ModelSIRDCONN.Rd
diff --git a/man/ModelSIRLogit.Rd b/man/ModelSIRLogit.Rd
diff --git a/man/ModelSIS.Rd b/man/ModelSIS.Rd
diff --git a/man/ModelSISD.Rd b/man/ModelSISD.Rd
diff --git a/man/ModelSURV.Rd b/man/ModelSURV.Rd
diff --git a/man/agents.Rd b/man/agents.Rd