add: Add a reference to a simulation

In jacobbien/simulator: An Engine for Running Simulations

Add a reference to a simulation

Description

Adds a ModelRef, DrawsRef, OutputRef, or EvalsRef to a simulation object. To add a DrawsRef, the corresponding ModelRef must already be added. Likewise, to add an OutputRef, the corresponding DrawsRef must already be added. And to add an EvalsRef, the corresponding OutputRef must be added. One can also pass a list of such objects.

Usage

add(sim, ref, ...)

## S4 method for signature 'Simulation,ModelRef'
add(sim, ref, update_saved = TRUE)

## S4 method for signature 'Simulation,DrawsRef'
add(sim, ref, update_saved = TRUE)

## S4 method for signature 'Simulation,OutputRef'
add(sim, ref, update_saved = TRUE)

## S4 method for signature 'Simulation,EvalsRef'
add(sim, ref, update_saved = TRUE)

## S4 method for signature 'Simulation,list'
add(sim, ref, update_saved = TRUE)

Arguments

sim	simulation being added to
ref	the reference object being added
...	not used
update_saved	default is TRUE. Determines whether change to simulation object should be saved to file

Details

The modified simulation object is saved to file if update_saved is TRUE.

jacobbien/simulator documentation built on Feb. 4, 2023, 1:03 p.m.