Create and modify argument sets, then make an argument grid for batch simulation
Source:R/batch_simulation.R
arg_set-class.Rd
An argument set contains the descriptions of the relevant variables in a
batch simulation. Use new_arg_set()
to create an arg_set
object, and use add_arg_ele()
to add an element to the arg_set
. After
adding all elements in the argument set, use make_arg_grid()
to make an
argument grid that can be used directly for running batch simulation.
Arguments
- arg_set
An
arg_set
object.- arg_name, ele_name
The name of the argument and its element in the simulation function
- start, end, by
The data points where you want to test the variables. Passed to
seq
.- x
An
arg_set
object- detail
Do you want to print the object details as a full list?
- ...
Not in use.
Value
new_arg_set()
returns an arg_set
object.
add_arg_ele()
returns an arg_set
object.
nele()
returns an integer.
narg()
returns an integer.
make_arg_gird()
returns an arg_grid
object.
Functions
new_arg_set()
: Create anarg_set
.add_arg_ele()
: Add an element to anarg_set
.nele()
: The number of elements in anarg_set
.narg()
: The number of arguments in anarg_set
.print(arg_set)
: Print anarg_set
object.make_arg_grid()
: Make an argument grid from an argument set.print(arg_grid)
: Print anarg_grid
object
See also
batch_simulation()
for running batch simulation and a
concrete example.