run_simulation_scenario: Run a built-in simulation scenario

View source: R/catalogues.R

run_simulation_scenarioR Documentation

Run a built-in simulation scenario

Description

Run a built-in simulation scenario

Usage

run_simulation_scenario(scenario, seed = NULL)

Arguments

scenario

A single scenario name from simulation_scenarios().

seed

Optional seed.

Value

The simulab_sim base data.frame returned by the simulator the scenario calls, whose columns depend on the scenario's family.

Examples

result <- run_simulation_scenario("small_effect", seed = 1)
head(result)

simulab documentation built on Oct. 15, 2026, 5:08 p.m.