Skip to contents

Add population predictions (PRED) to a data.frame

Source: R/mrgsim_addpred.R
df_mrgsim_addpred.Rd

df_mrgsim_addpred() is a wrapper function for mrgsolve::mrgsim_df() and mrgsolve::zero_re() that returns a data.frame with the addition of a new variable (PRED).

Usage

df_mrgsim_addpred(data, model, ipred_output = "IPRED", ..., output_var)

Arguments

data

Input dataset.

model

mrgsolve model object.

ipred_output

Name of the individual prediction output captured by model. It is simulated with random effects zeroed (mrgsolve::zero_re()) and returned as PRED. Accepts bare names or strings. Default is IPRED.

...

Additional arguments passed to mrgsolve::mrgsim_df(). A carry_out is merged with ipred_output. Arguments that change the number of output rows (e.g. obsonly) are an error, since PRED is matched to data by row.

output_var

[Deprecated] Use ipred_output.

Value

A data.frame with the same number of rows as data and on additional numeric variable PRED.

See also

Other mrgsolve wrappers: df_mrgsim_replicate(), model_mread_load()

Examples

pkmodel <- model_mread_load(model = "pkmodel")
#> Loading model from cache.
data <- df_mrgsim_addpred(data = dplyr::filter(data_sad, CMT != 3), model = pkmodel)