list_simulators: List public simulation and generation verbs

View source: R/api.R

list_simulatorsR Documentation

List public simulation and generation verbs

Description

List public simulation and generation verbs

Usage

list_simulators(family = NULL, kind = NULL, dispatchable = NULL)

Arguments

family

Optional single-string family filter, one of "general", "statistical", "latent", "longitudinal", "measurement", "sequence", "survival", "empirical", "functional" or "network". An unknown family is an error.

kind

Optional single-string kind filter: "simulator", "generator", "workflow", or "dispatcher". An unknown kind is an error.

dispatchable

Optional single logical filter: TRUE keeps only the verbs that can be called through simulate_data(), FALSE keeps only those that cannot.

Value

A base data.frame with one row per catalogued verb and the columns simulator (the catalogue name), function_name, kind, family, primary_shape and dispatchable.

Examples

head(list_simulators())
list_simulators(kind = "workflow")

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