# An Engine for Running Simulations

## Documentation for package ‘simulator’ version 0.2.0

- DESCRIPTION file.
- User guides, package vignettes and other documentation.

## Help Pages

$-method | Get element of 'Model"s 'params' list
+-method | Create an ExtendedMethod from a Method and MethodExtension
+-method | Create a list of ExtendedMethod from a list of Methods and a MethodExtension
add | Add a reference to a simulation
add-method | Add a reference to a simulation
aggregate_evals | Apply aggregator to a list of Evals objects
Aggregator-class | An S4 class for aggregating evaluated metrics
as.data.frame.Evals | Convert an Evals to a data.frame
as.data.frame.listofEvals | Convert a list of Evals to a data.frame
as.data.frame.listofModels | Convert a List of Models to a data.frame
as.data.frame.Model | Convert a Model to a data.frame
catsim | Concatenate and print for the simulator
Component-class | An S4 class representing a component of the simulator.
create | Create template for a new set of simulations
describe | Describe the contents of a simulator directory
draws | Get one or more draws from a simulation
Draws-class | An S4 class representing the random draws from a Model object.
DrawsRef-class | An S4 class representing a reference to an object of class Draws.
evals | Get one or more evals from a simulation
Evals-class | An S4 class representing the evaluation of a metric run by simulator.
EvalsRef-class | An S4 class representing a reference to an object of class Evals
evaluate | Evaluate outputs of methods according to provided metrics.
evaluate_internal | Evaluate outputs of methods according to provided metrics.
evaluate_single | Run one or more metrics on outputs.
ExtendedMethod-class | An S4 class representing the extension of a method
generate_model | Generate a model.
get_contents | Get the contents of a simulator directory
get_files_not_in_simulations | Find files in simulator directory not referred to by any simulations
get_model_indices | Returns indices of a specified subset of sim@model_refs
get_relative_path | Get relative path
get_simulation_with_all_files | Returns a simulation object containing references to all files in directory
load-method | Load a DrawsRef
load-method | Load an EvalsRef
load-method | Load a ModelRef
load-method | Load an OutputRef
load-method | Load a list of reference objects
load_draws | Load one or more draws objects from file.
load_evals | Load one or more Evals objects from file.
load_evals_from_ref | Load one or more Evals objects from file.
load_model | Load a model from file.
load_simulation | Load a simulation object
make_my_example_model | Make My Example Model
memory_as_string | Write memory in human readable way
Method-class | An S4 class representing a method to be run by simulator.
MethodExtension-class | An S4 class used to create an extended version of a method
Metric-class | An S4 class representing an evaluation metric to be used by simulator.
model | Get one or more models from a simulation
Model-class | An S4 class representing the model component of the simulator.
ModelRef-class | An S4 class representing a reference to an object of class Model.
models_as_data.frame | Convert a list of Model objects into a data.frame
model_names | Get model names in a Simulation
my_example_loss | My Example Loss
my_example_method | My Example Method
new_aggregator | Create an Aggregator object
new_extended_method | Create an ExtendedMethod object
new_method | Create a Method object
new_method_extension | Create an object that can be used to make an extended version of a method
new_metric | Create a Metric object
new_model | Create a Model object
new_simulation | Make a new simulation object
output | Get one or more outputs from a simulation
Output-class | An S4 class representing the output of a method run by simulator.
OutputRef-class | An S4 class representing a reference to an object of class Output.
plot_eval | Make a boxplot of a metric for each method
plot_evals | Plot one metric versus another for each method
plot_eval_by | Plot a metric across multiple values of a model parameter
recycle | Recycles elements to create vector of desired length
relabel | Give simulation a new label
rename | Give simulation a new name
run_extendedmethod_single | Run a single extended method on a single index of simulated data.
run_method | Run one or more methods on simulated data.
run_method_single | Run a single method on a single index of simulated data.
save_simulation | Save a simulation object
simulate_from_model | Simulate from a model.
simulate_from_model_single | Simulate from a model.
simulate_parallel | Simulate from a model in parallel.
Simulation-class | An S4 class representing a simulation.
subset_evals | Reduce an Evals object to a subset of methods and/or metrics
subset_models | Subset Models
subset_simulation | Create a simulation that is a subset of a preexisting simulation object
tabulate_eval | Make a table of a metric for each pair of models and methods