simulatr_specifier: simulatr_specifier

In timothy-barry/simulatr: Design Portable and Scalable Simulation Studies

simulatr_specifier

Description

A simulatr_specifier object defines a simulation study in the simulatr framework.

Usage

simulatr_specifier(
  parameter_grid,
  fixed_parameters,
  generate_data_function,
  run_method_functions,
  evaluation_functions = list()
)

Arguments

parameter_grid	a named data frame storing the values of study parameters that vary
fixed_parameters	a named list storing the values of the parameters that stay fixed across parameter settings
generate_data_function	a simulatr_function that generates the data
run_method_functions	a named list of simulatr_functions that define the methods to be run in the simulation
evaluation_functions	a named list of functions that define the metrics used to evaluate each method

Value

a simulatr_specifier object

timothy-barry/simulatr documentation built on Sept. 6, 2024, 7:10 p.m.