ev {mrgsolve} | R Documentation |
Event objects for simulating PK and other interventions
Description
An event object specifies dosing or other interventions that get implemented during simulation. Event objects do similar things as data_set, but simpler and easier to create.
Usage
ev(x, ...)
## S4 method for signature 'mrgmod'
ev(x, object = NULL, ...)
## S4 method for signature 'missing'
ev(
time = 0,
amt = 0,
evid = 1,
cmt = 1,
ID = numeric(0),
replicate = TRUE,
until = NULL,
tinf = NULL,
realize_addl = FALSE,
...
)
## S4 method for signature 'ev'
ev(x, realize_addl = FALSE, ...)
Arguments
x |
a model object. |
... |
other items to be incorporated into the event object; see Details. |
object |
an event object to be added to a model object. |
time |
event time. |
amt |
dose amount. |
evid |
event ID. |
cmt |
compartment number or name. |
ID |
subject ID. |
replicate |
logical; if |
until |
the expected maximum observation time for this regimen;
doses will be scheduled up to, but not including, the |
tinf |
infusion time; if greater than zero, then the |
realize_addl |
if |
Details
Required items in events objects include
time
,amt
,evid
andcmt
.If not supplied,
evid
is assumed to be 1.If not supplied,
cmt
is assumed to be 1.If not supplied,
time
is assumed to be 0.If
amt
is not supplied, an error will be generated.If
total
is supplied, thenaddl
will be set tototal-1
.Other items can include
ii
,ss
, andaddl
(see data_set for details on all of these items).-
ID
may be specified as a vector. If replicate is
TRUE
(default), then the events regimen is replicated for eachID
; otherwise, the number of event rows must match the number ofID
s entered.
Value
ev()
returns an event object.
See Also
evd()
, ev_rep()
, ev_days()
, ev_repeat()
, ev_assign()
,
ev_seq()
, mutate.ev()
, as.ev()
, as.evd()
, ev_methods.
Examples
mod <- mrgsolve::house()
mod <- mod %>% ev(amt = 1000, time = 0, cmt = 1)
loading <- ev(time = 0, cmt = 1, amt = 1000)
maint <- ev(time = 12, cmt = 1, amt = 500, ii = 12, addl = 10)
c(loading, maint)
reduced_load <- dplyr::mutate(loading, amt = 750)
# Three additional doses in this case
e <- ev(amt = 100, ii = 4*7, until = 16*7)
e
# Last dose is given at 84
realize_addl(e)
# Four additional doses with last at 112 in this case
e <- ev(amt = 100, ii = 4*7, until = 16*7 + 0.001)
realize_addl(e)