evaluator (version 0.4.3)

run_simulation: Run simulations for a scenario

Description

Given a quantitative scenario object of type tidyrisk_scenario, run an OpenFAIR Monte Carlo simulation.

Usage

run_simulation(
  scenario,
  iterations = 10000L,
  ale_maximum = NULL,
  verbose = FALSE,
  simulation_count = NULL
)

Arguments

scenario

A tidyrisk_scenario object.

iterations

Number of iterations to run on each scenario.

ale_maximum

Maximum practical annual losses.

verbose

Whether verbose console output is requested.

simulation_count

DEPRECATED Number of simulations to perform.

Value

Dataframe of results.

Examples

# NOT RUN {
data(mc_quantitative_scenarios)
run_simulation(mc_quantitative_scenarios$scenario[[1]], 10)
# }