modify_bbi_args: Modify bbi_args on a model object

In metrumresearchgroup/rbabylon: R package for bbi

Modify bbi_args on a model object

Description

Add or replace the bbi_args field on a model object and corresponding YAML.

Usage

add_bbi_args(.mod, .bbi_args)

replace_all_bbi_args(.mod, .bbi_args)

Arguments

.mod	The ⁠bbi_{.model_type}_model⁠ object to modify
.bbi_args	named list of arguments to add to the model. See print_bbi_args() for valid options.

Details

The bbi_args field on a ⁠bbi_{.model_type}_model⁠ object contains a named list of arguments that will be passed through to bbi to modify how a model is processed (for instance, when it is submitted to be run with submit_model()). In many cases, it is preferable to store these arguments with the model object, as opposed to passing them to submit_model(.bbi_args) because then they will be applied every time that model is run, for example if you need to re-run the model later.

The options for what can be included in this list (and a brief description of what each does) can be seen by calling print_bbi_args().

Note that there is no replace_bbi_arg (singular) to replace individual arguments. This is because you can use add_bbi_args() and any arguments passed in will automatically overwrite any previous value stored for that argument.

Value

The modified ⁠bbi_{.model_type}_model⁠ object

Functions

• add_bbi_args(): Modifies model object and corresponding YAML by adding named list passed to .bbi_args, overwriting any args that are already present with the new values.

• replace_all_bbi_args(): Modifies model object and corresponding YAML by replacing all bbi_args with named list passed to .bbi_args.

See Also

submit_model() model_summary() print_bbi_args() modify_tags() modify_notes() modify_based_on() modify_description() modify_star()

metrumresearchgroup/rbabylon documentation built on April 21, 2024, 3:26 a.m.