set_tag: Set a tag

View source: R/set.R

set_tagR Documentation

Set a tag

Description

Sets the user-defined, custom tag of a scenario. Tags can be helpful to quickly distinguish scenarios of the same model type.

Usage

set_tag(x, tag)

Arguments

x

(vector of) EffectScenario objects

tag

vector of character

Value

(vector of) modified EffectScenario objects

See Also

get_tag()

Examples

# set a custom tag
myscenario <- GUTS_RED_SD() %>% set_tag("My Custom Tag")

# returns `My Custom Tag`
get_tag(myscenario)

# the tag also appears in the scenario overview
myscenario

cvasi documentation built on Sept. 23, 2024, 9:08 a.m.