set_tag: Set a tag

In cvasi: Calibration, Validation, and Simulation of TKTD Models

Set a tag

Description

Sets the user-defined, custom tag of a scenario. Tags can be helpful to quickly distinguish scenarios by e.g. a user-specified string.

Usage

set_tag(x, tag)

Arguments

x	(vector of) scenario objects
tag	(vector of) character or any other object

Details

The function supports vectorized inputs. If arguments x and tag are vectors, then tags are assigned to scenarios on a 1:1 basis. If the length of both vectors do not match, an error is raised.

Value

(vector of) modified scenarios

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. 11, 2025, 5:11 p.m.