Correcting doc about initial stateds

UofUEpiBio · Dec 3, 2023 · 9c7d3df · 9c7d3df
1 parent a76ac7f
commit 9c7d3df
Show file tree

Hide file tree

Showing 14 changed files with 14 additions and 14 deletions.
diff --git a/R/ModelSEIR.R b/R/ModelSEIR.R
@@ -13,7 +13,7 @@
 #' @family Models
 #' @aliases epiworld_seir
 #' @details 
-#' The [initial_state] function allows the user to set the initial state of the
+#' The [initial_states] function allows the user to set the initial state of the
 #' model. The user must provide a vector of proportions indicating the following
 #' values: (1) Proportion of non-infected agents who are removed, and (2)
 #' Proportion of exposed agents to be set as infected.

diff --git a/R/ModelSEIRD.R b/R/ModelSEIRD.R
@@ -12,7 +12,7 @@
 #' @param ... Currently ignore.
 #' @export
 #' @details 
-#' The [initial_state] function allows the user to set the initial state of the
+#' The [initial_states] function allows the user to set the initial state of the
 #' model. The user must provide a vector of proportions indicating the following
 #' values: (1) Proportion of exposed agents who are infected, (2)
 #' proportion of non-infected agents already removed, and (3) proportion of

diff --git a/R/ModelSEIRDCONN.R b/R/ModelSEIRDCONN.R
@@ -18,7 +18,7 @@
 #' @param n Number of individuals in the population.
 #' @export
 #' @details 
-#' The [initial_state] function allows the user to set the initial state of the
+#' The [initial_states] function allows the user to set the initial state of the
 #' model. The user must provide a vector of proportions indicating the following
 #' values: (1) Proportion of exposed agents who are infected, (2)
 #' proportion of non-infected agents already removed, and (3) proportion of

diff --git a/R/ModelSIR.R b/R/ModelSIR.R
@@ -14,7 +14,7 @@
 #' @export
 #' @family Models
 #' @details 
-#' The [initial_state] function allows the user to set the initial state of the
+#' The [initial_states] function allows the user to set the initial state of the
 #' model. In particular, the user can specify how many of the non-infected
 #' agents have been removed at the beginning of the simulation.
 #' @aliases epiworld_sir

diff --git a/R/ModelSIRCONN.R b/R/ModelSIRCONN.R
@@ -11,7 +11,7 @@
 #' @export
 #' @family Models
 #' @details 
-#' The [initial_state] function allows the user to set the initial state of the
+#' The [initial_states] function allows the user to set the initial state of the
 #' model. In particular, the user can specify how many of the non-infected
 #' agents have been removed at the beginning of the simulation.
 #' @returns

diff --git a/R/ModelSIRD.R b/R/ModelSIRD.R
@@ -14,7 +14,7 @@
 #' @param ... Additional arguments passed to [graphics::plot].
 #' @export
 #' @details
-#' The [initial_state] function allows the user to set the initial state of the
+#' The [initial_states] function allows the user to set the initial state of the
 #' model. The user must provide a vector of proportions indicating the following
 #' values: (1) proportion of non-infected agents already removed, and (2) proportion of
 #' non-ifected agents already deceased.

diff --git a/R/ModelSIRDCONN.R b/R/ModelSIRDCONN.R
@@ -11,7 +11,7 @@
 #' @param n Number of individuals in the population.
 #' @export
 #' @details 
-#' The [initial_state] function allows the user to set the initial state of the
+#' The [initial_states] function allows the user to set the initial state of the
 #' model. The user must provide a vector of proportions indicating the following
 #' values: (1) proportion of non-infected agents already removed, and (2) proportion of
 #' non-ifected agents already deceased.

diff --git a/man/ModelSEIR.Rd b/man/ModelSEIR.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