system_new_tt_rule: Titration Rules

Description Usage Arguments Details Value See Also

View source: R/ubiquity.r

Description

Defines a new titration rule and the times when that rule is evaluated

Usage

1
system_new_tt_rule(cfg, name, times, timescale)

Arguments

cfg

ubiquity system object

name

name for the titration rule

times

list of times when the rule will be evaluated

timescale

time scale associated with the titration times (as defined by <TS:?>)

Details

1
2
3
4
cfg = system_new_tt_rule(cfg,
                        name      = "rname",
                        times     = c(0, 2, 4),
                        timescale = "weeks")'

A titration rule identifies a set of times (times) and an associated time scale (timescale) in which titration events can potentially occur. Any times scale, as defined in the system file with <TS:?>, can be used in place of "weeks" above. The name, "rname" above, is used to link the titration rule to different conditions discussed below. The name should be a string beginning with a letter, and it can contain any combination of numbers, letters, and underscores. With the rule created we can then add conditions to that rule.'

Value

Ubiquity system object with the titration rule created

See Also

system_set_tt_cond, run_simulation_titrate


ubiquity documentation built on Sept. 5, 2021, 5:15 p.m.