modify_model_field: Modify field in model object

Description Usage Arguments

View source: R/modify-model-field.R

Description

Implementation function for updating fields in a 'bbi_.model_type_model' object Also checks the object against the corresponding YAML before modifying (and errors if they are out of sync) and then writes the modified object back to the YAML.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
modify_model_field(.mod, .field, .value, .append = TRUE, .unique = TRUE)

add_tags(.mod, .tags)

replace_tags(.mod, .tags)

add_decisions(.mod, .decisions)

replace_decisions(.mod, .decisions)

add_based_on(.mod, .based_on)

replace_based_on(.mod, .based_on)

replace_description(.mod, .description)

Arguments

.mod

The 'bbi_.model_type_model' object to modify

.field

Character scaler of the name of the component to modify

.value

Whatever is to be added to '.mod[[.field]]', typically a character scaler or vector

.append

Boolean for whether to concatenate new values with currently present values. TRUE by default. If FALSE, new values will overwrite old values.

.unique

Boolean for whether to de-duplicate '.mod[[.field]]' after adding new values. TRUE by default.

.tags

Character scaler or vector of tags use as replacement

.decisions

Character scaler or vector to use as replacement

.based_on

Character scaler or vector to use as replacement

.description

Character scaler to use as replacement


metrumresearchgroup/mrgvalidatetestreference documentation built on Aug. 15, 2021, 8:13 a.m.