modify_description.RdAdd or replace a description on a model object and corresponding YAML. The description can be modified at any time (i.e. before or after a model is submitted).
add_description(.mod, .description) replace_description(.mod, .description)
| .mod | The |
|---|---|
| .description | Character scalar to put in |
The modified bbi_{.model_type}_model object
The description field on a bbi_{.model_type}_model object contains a character
scalar with a brief description of the model. Note that it is not a required field
and some users prefer to leave it blank and instead use the tags and/or notes fields
to describe their models instead.
Another pattern is to fill the description field only on notable models,
for instance with "Base Model" or "Final Model". This can be useful when
looking at a bbi_run_log_df (the tibble output from run_log()); for
example to look at only the most important models by calling
run_log() %>% filter(!is.na(description)).
add_description: Fills the description field in a model object and corresponding YAML, if it is currently empty.
replace_description: Replaces description field in a model object and corresponding YAML with new description.