system_new_tt_rule function

Titration Rules

Titration Rules

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

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:?>)

Returns

Ubiquity system object with the titration rule created

Details

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.'

See Also

system_set_tt_cond, run_simulation_titrate

  • Maintainer: John Harrold
  • License: BSD_2_clause + file LICENSE
  • Last published: 2025-01-07