check_simulatr_specifier_object: Check simulatr specifier object

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

Check simulatr specifier object

Description

Checks a simulatr specifier object for correctness.

Usage

check_simulatr_specifier_object(
  simulatr_spec,
  B_in = NULL,
  return_data = FALSE,
  parallel = TRUE
)

Arguments

simulatr_spec	a simulatr_specifier object
B_in	(default determined by simulatr_spec) number of resamples to use
return_data	(default false) whether to return the data
parallel	(default true) parallelize execution?

Value

if no errors, the list of results; if errors occur, the ordered list of arguments passed to the function in which the error occurred.

Examples

## Not run: 
simulatr_spec <-
readRDS("/Users/timbarry/research_offsite/glmeiv/private/simulations/sim_spec_1.rds")
simulatr_spec@parameter_grid  <- simulatr_spec@parameter_grid[1:10,]
simulatr_spec@fixed_parameters[["n"]] <- 2000
check <- check_simulatr_specifier_object(simulatr_spec, 5)

## End(Not run)

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