exmodel_exdata {mapbayr} | R Documentation |
Example model and data
Description
A collection of example models and corresponding data to test and explore mapbayr
.
Usage
exmodel(
num = 1,
add_exdata = TRUE,
cache = TRUE,
quiet = getOption("mrgsolve_mread_quiet", TRUE),
...,
ID = 1,
clean_data = TRUE
)
exdata(num = 1, ID = 1, clean_data = TRUE)
Arguments
num |
model number (see details) |
add_exdata |
should data be automatically loaded with the model |
cache |
read the model with |
quiet |
don't print messages when compiling |
... |
passed to |
ID |
individual number to include in the data (from 1 to 8) |
clean_data |
remove useless columns and rows from the original data |
Details
Available models are:
1: Base model. A simple monocompartmental PK model with inter-individual variability on absorption constant (KA), volume of distribution (VC) and clearance (CL). The residual error model is proportional.
6: Complex absorption model. Dual 0- and 1st orders absorption phenomenons.
301: Time-varying covariates. A continuous covariate (body weight "BW") and a categorical one (sex "SEX") influence the clearance parameter. In the corresponding dataset, the values randomly changes from one record to another within a single individual.
401: Metabolite. The PK model of both a parent drug and its metabolite.
An example dataset of eight (simulated) individuals is available for each model. Individuals differ in terms of sampling times (sparse or rich) and dosing regimen (single or multiple dosing).
Model code and data files are stored at the location given by system.file("exmodel", package = "mapbayr")
.
These models and data were created for the validation study of mapbayr
published in CPT:Pharmacometrics & System Pharmacology. More models and full datasets can be accessed in a dedicated repository
Value
exmodel()
reads and compiles code, and returns a (mrgmod
) model object. exdata()
returns a data.frame.
Source
https://github.com/FelicienLL/mapbayr-CPTPSP-2021
Examples
# Models can be loaded with data (the default), ready for parameter estimation
est <- mapbayest(exmodel())
# Number of subjects in dataset can be chosen up to 8 individuals
exdata(301, ID = c(5,8))