mrgsolve (version 0.8.12)

data_set: Select and modify a data set for simulation

Description

Select and modify a data set for simulation

Usage

data_set(x, data, ...)
# S4 method for mrgmod,data.frame
data_set(x, data, .subset = TRUE,
  .select = TRUE, object = NULL, need = NULL, ...)
# S4 method for mrgmod,ANY
data_set(x, data, ...)
# S4 method for mrgmod,ev
data_set(x, data, ...)
# S4 method for mrgmod,missing
data_set(x, object, ...)

Arguments

x

model object

data

data set

...

passed along

.subset

an unquoted expression passed to dplyr::filter; retain only certain rows in the data set

.select

passed to dplyr::select; retain only certain columns in the data set; this should be the result of a call to dplyr::vars()

object

character name of an object existing in $ENV to use for the data set

need

passed to inventory

Details

Input data sets are R data frames that can include columns with any valid name, however columns with selected names are treated specially by mrgsolve and incorporated into the simulation.

ID specifies the subject ID and is required for every input data set.

When columns have the same name as parameters ($PARAM in the model specification file), the values in those columns will be used to update the corresponding parameter as the simulation progresses.

Input data set may include the following columns related to PK dosing events: time, cmt, amt, rate, ii, addl, ss. time and cmt (and ID) are required columns in the input data set. time is the observation or event time, cmt is the compartment number (see init), amt is the dosing amount, rate is the infusion rate, ii is the dosing interval, addl specifies additional doses to administer, and ss is a flag for steady state dosing. These column names operate similarly to other non-linear mixed effects modeling software. Upper case PK dosing column names including TIME, CMT, AMT, RATE, II, ADDL, SS are also recognized. However, an error will be generated if a mix of upper case and lower case columns are found.

Only numeric data can be brought in to the problem. Any non-numeric data columns will be dropped with warning.

See exdatasets for different example data sets.

See Also

idata_set, ev, valid_data_set, valid_idata_set

Examples

# NOT RUN {
mod <- mrgsolve:::house()

data <- expand.ev(ID=1:3, amt=c(10,20))

mod %>% data_set(data, ID > 1) %>% mrgsim

data(extran1)
head(extran1)

mod %>% data_set(extran1) %>% mrgsim
mod %>% mrgsim(data=extran1)

# }