Skip to contents

Class <VarFn>

Source: R/class-VarFn.R
VarFn-class.Rd

<VarFn> is an S4 class that declares the functional properties of a variable of interest to be used in the IBM simulation.

Details

It enables the specification of a variable as a function of one or more predictors through an expression, thereby describing the relationship between the variable and its explanatory factors. This provides a structured approach to incorporating dynamic dependencies between model components. This class extends from the VarDist class, inheriting its slots.

Slots

fn

a function, providing the functional relationship between a model variable and predicting factors.

args_spec

a list of <ArgSpec> objects, one for each argument of fn.

units

character string defining the output units of fn. Units must be recognized by the units::valid_udunits() database.

fn_cmp

compiled version fn, resulting from applying e.g. build_cost_fn() to fn.

See also

Helper function VarFn() to construct <VarFn> objects.