Skip to contents

Convenience function: run simulation and return results

simulate.Rd

This is a simplified interface that handles session management automatically and returns the results directly. Ideal for most users. Progress information is displayed including: configuration summary, a real-time progress bar showing percentage completion (10

Usage

simulate(
  input = NULL,
  settings = NULL,
  jurisdiction = "canada",
  time_horizon = 20,
  n_agents = NULL,
  return_extended = FALSE,
  return_events = FALSE
)

Arguments

input

customized input criteria (optional)

settings

customized settings (optional)

jurisdiction

Jurisdiction for model parameters ("canada" or "us")

time_horizon

Model time horizon in years (default: 20)

n_agents

Number of agents to simulate (default: 60,000)

return_extended

whether to return extended results in addition to basic (default: FALSE)

return_events

whether to return event matrix (default: FALSE). If TRUE, automatically sets record_mode=2

Value

list with simulation results (always includes 'basic', optionally 'extended' and 'events')

Examples

if (FALSE) { # \dontrun{
# Simplest usage
results <- simulate()
print(results$basic)

# With custom parameters
results <- simulate(jurisdiction = "us", time_horizon = 10, n_agents = 100000)

# Quick test with fewer agents
results <- simulate(n_agents = 10000)

# With extended output (includes both basic and extended)
results <- simulate(return_extended = TRUE)
print(results$basic)
print(results$extended)

# With event history
results <- simulate(return_events = TRUE)
print(results$events)  # Event matrix
} # }