get_param_from_simulatr_spec: Get parameter from simulatr_specifier object

View source: R/parameter_accessors.R

get_param_from_simulatr_specR Documentation

Get parameter from simulatr_specifier object

Description

Returns the requested parameter from a simulatr_specifier object.

Usage

get_param_from_simulatr_spec(simulatr_spec, row_idx, param)

Arguments

simulatr_spec

a simulatr_specifier object

row_idx

index giving the row of the parameter grid; if NULL, returns all values (if parameter stored in grid) or fixed value (if parameter stored in fixed params list)

param

name of the parameter

Details

If the parameter is present in both the parameter grid and the fixed parameter list, returns value from parameter grid. If parameter is not present in either, throws an error.

Value

the value of the requested parameter


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