simulate_scenarios: Run a simulator across a scenario grid

In simulab: Simulates a Wide Variety of Data Shapes, Sizes and Distributions

Run a simulator across a scenario grid

Description

Every column of scenarios other than id and replication is passed to the simulator as a named argument, so the column names must be simulator argument names and must not repeat an argument given in .... The identifier and replication values are prepended to each generated observation, which makes the result immediately suitable for grouped estimation and recovery checks. Every scenario must produce the same primary columns, otherwise the run is an error.

Usage

simulate_scenarios(
  scenarios,
  simulator,
  ...,
  id = "scenario_id",
  replication = "replication",
  seed = NULL
)

Arguments

scenarios	A base data.frame with at least one row, commonly from scenario_grid(), containing the id and replication columns.
simulator	Canonical simulator name, taken from the simulator column of list_simulators() and dispatched through simulate_data().
...	Arguments held constant across scenarios.
id	Single string naming the scenario identifier column of scenarios, default "scenario_id".
replication	Single string naming the replication column of scenarios, default "replication".
seed	Optional single base seed. Row i of scenarios is simulated with seed + i - 1, unless scenarios or ... already supplies a seed.

Value

A simulab_sim base data.frame stacking every scenario's output, with one row per generated observation: the id and replication columns first, then the simulator's own columns. The scenarios component holds the grid that was run, one row per scenario.

Examples

scenarios <- scenario_grid(mean_b = c(0, 0.5), replications = 2)
result <- simulate_scenarios(
  scenarios, simulator = "ttest",
  n_a = 20, n_b = 20, mean_a = 0, seed = 1
)
head(result)

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