Function reference • simulator

Getting started

A useful way to get started is to call this function from the console.

create(): Create template for a new set of simulations

Running a simulation

These are the most common functions you’ll use when running a simulation.

new_simulation(): Make a new simulation object

generate_model(): Generate a model.

simulate_from_model(): Simulate from a model.

run_method(): Run one or more methods on simulated data.

evaluate(): Evaluate outputs of methods according to provided metrics.

Defining simulation components

These are the functions you’ll use when defining the components of a simulation.

new_model(): Create a Model object

new_method(): Create a Method object

new_metric(): Create a Metric object

new_method_extension(): Create an object that can be used to make an extended version of a method

new_aggregator(): Create an Aggregator object

Loading saved files from simulation

These are functions for loading files that were created when you ran your simulation. These allow you to look at simulation outputs at various intermediate stages of the simulation process.

load_simulation(): Load a simulation object

subset_simulation(): Create a simulation that is a subset of a preexisting simulation object

model(): Get one or more models from a simulation

draws(): Get one or more draws from a simulation

output(): Get one or more outputs from a simulation

evals(): Get one or more evals from a simulation

Making plots and tables

Functions for making the most common plots and tables in a simulation. For more customized plots, you can instead export the simulation outputs to a data.frame and then make your own plots.

plot_eval(): Plot a metric's value for each method

plot_eval_by(): Plot a metric across multiple values of a model parameter

plot_evals(): Plot one metric versus another for each method

tabulate_eval(): Make a table of a metric for each pair of models and methods

aggregate_evals(): Apply aggregator to a list of Evals objects

Managing simulation files

Functions for checking and manipulating the files that have been stored by the simulator. This is for more advanced use.

get_contents(): Get the contents of a simulator directory

describe(): Describe the contents of a simulator directory

get_files_not_in_simulations(): Find files in simulator directory not referred to by any simulations

get_simulation_with_all_files(): Returns a simulation object containing references to all files in directory

add(): Add a reference to a simulation

save_simulation(): Save a simulation object