get_tag: Get scenario tag

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

Get scenario tag

Description

Returns the user-defined, custom tag of a scenario, if available. Tags can be helpful to quickly distinguish scenarios by e.g. a user-specified string. The function supports vectorized inputs. If more than one scenario is supplied in argument x, then a list of tags is returned.

Usage

get_tag(x)

## S4 method for signature 'list'
get_tag(x)

## S4 method for signature 'EffectScenario'
get_tag(x)

## S4 method for signature 'ScenarioSequence'
get_tag(x)

## S4 method for signature 'ParameterSet'
get_tag(x)

Arguments

x	(vector of) scenarios or parameter_set objects

Value

(list of) tag(s), returns NA if no tag was set

Methods (by class)

• get_tag(list): Returns a list of tags (if applicable)

• get_tag(EffectScenario): Returns the tag of a single scenario

• get_tag(ScenarioSequence): Returns a list of tags, one for each scenario in the sequence

• get_tag(ParameterSet): Returns the tag of a single parameter_set

See Also

set_tag()

Examples

# returns `fathead minnow`
get_tag(minnow_it)

# update or set a tag
myscenario <- GUTS_RED_IT() %>% set_tag("My Custom Tag")
# returns `My Custom Tag`
get_tag(myscenario)

cvasi documentation built on Sept. 11, 2025, 5:11 p.m.