run_simulations: Run simulations for a list of scenarios

Description Usage Arguments Value Examples

View source: R/simulate.R

Description

Given a list of quantitative scenario objects of type tidyrisk_scenario, run a OpenFAIR Monte Carlo simulation for each scenario.

Usage

1
2
3
4
5
6
7
8
run_simulations(
  scenario,
  ...,
  iterations = 10000L,
  ale_maximum = NULL,
  verbose = FALSE,
  simulation_count = NULL
)

Arguments

scenario

A tidyrisk_scenario object.

...

Additional tidyrisk_scenario objects to simulate.

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

A list of one dataframe of results for each scenario.

Examples

1
2
3
4
5
6
# fetch three scenarios for this example
data(mc_quantitative_scenarios)
scenario_a <- mc_quantitative_scenarios$scenario[[1]]
scenario_b <- mc_quantitative_scenarios$scenario[[2]]
scenario_c <- mc_quantitative_scenarios$scenario[[3]]
run_simulations(scenario_a, scenario_b, scenario_c, iterations = 10)

evaluator documentation built on July 6, 2021, 9:06 a.m.