Simulate data through the unified catalogue

simulate_data() is a discoverable dispatcher. Direct verbs remain the preferred interface because they provide explicit, documented arguments.

Usage

simulate_data(type, ...)

Arguments

type

Dispatchable simulator name, taken from the simulator column of list_simulators(). An unknown name, or a name whose dispatchable entry is FALSE, is an error.

...

Arguments passed on to the selected canonical simulation verb, including batch for every verb that produces one dataset.

Value

Whatever the selected verb returns, which for every dispatchable entry is a simulab_sim base data.frame, or a plain list of them when batch is given.

Examples

result <- simulate_data("ttest", n_a = 30, n_b = 30, mean_a = 0, mean_b = 0.5, seed = 1)
head(result)
#> <simulab_sim:ttest> 6 rows x 3 columns
#>   id group    outcome
#> 1  1     A -0.6264538
#> 2  2     A  0.1836433
#> 3  3     A -0.8356286
#> 4  4     A  1.5952808
#> 5  5     A  0.3295078
#> 6  6     A -0.8204684
#> 
#> Truth (parameters):
#>   group  n mean sd
#> 1     A 30  0.0  1
#> 2     B 30  0.5  1
#> 
#> Other tables: effects. Read one with as.data.frame(x, what = "effects").
# Five independent datasets from one call.
datasets <- simulate_data("ttest", n_a = 30, n_b = 30, mean_a = 0,
                          mean_b = 0.5, seed = 1, batch = 5)
length(datasets)
#> [1] 5