mrgsolve (version 1.5.2)

inventory: Check whether all required parameters needed in a model are present in an object

Description

This function has largely been superseded by check_data_names().

Usage

inventory(x, obj, ..., .strict = FALSE)

Value

x is returned invisibly.

Arguments

x

model object.

obj

data.frame to pass to idata_set() or data_set().

...

capture dplyr-style parameter requirements.

.strict

whether to stop execution if all requirements are present (TRUE) or just warn (FALSE); see Details.

Details

If parameter requirements are not explicitly stated, the requirement defaults to all parameter names in x. Note that, by default, the inventory is not .strict unless the user explicitly states the parameter requirement. That is, if parameter requirements are explicitly stated, .strict will be set to TRUE if a value .strict was not passed in the call.

See Also

check_data_names()

Examples

if (FALSE) {
  inventory(mod, idata, CL:V) # parameters defined, inclusively, CL through Volume 
  inventory(mod, idata, everything()) # all parameters
  inventory(mod, idata, contains("OCC")) # all parameters containing OCC
  inventory(mod, idata, -F) # all parameters except F
}