Skip to content

Commit

Permalink
Add missing param docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
plietar committed Jan 29, 2024
1 parent 2eace4c commit a22d7e3
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 5 deletions.
2 changes: 2 additions & 0 deletions R/simulation.R
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
#' @param processes a list of processes to execute on each timestep
#' @param timesteps the end timestep of the simulation. If `state` is not NULL, timesteps must be greater than `state$timestep`
#' @param state a checkpoint from which to resume the simulation
#' @param restore_random_state if TRUE, restore R's global random number generator's state from the checkpoint.
#' @examples
#' population <- 4
#' timesteps <- 5
Expand Down Expand Up @@ -100,6 +101,7 @@ checkpoint_state <- function(timesteps, variables, events) {
#' @param state the simulation state to restore, as returned by \code{\link[individual]{restore_state}}.
#' @param variables the list of Variables
#' @param events the list of Events
#' @param restore_random_state if TRUE, restore R's global random number generator's state from the checkpoint.
restore_state <- function(state, variables, events, restore_random_state) {
timesteps <- state$timesteps + 1

Expand Down
2 changes: 1 addition & 1 deletion man/Event.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/TargetedEvent.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 3 additions & 1 deletion man/restore_state.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 5 additions & 2 deletions man/simulation_loop.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit a22d7e3

Please sign in to comment.