mread: Read a model specification file

Description

mread reads and parses a mrgsolve model specification file, builds the model, and returns a model object for simulation.

Usage

mread(model, project = getwd(), code = NULL, file = NULL, udll = TRUE,
  ignore.stdout = TRUE, raw = FALSE, compile = TRUE, audit = TRUE,
  quiet = getOption("mrgsolve_mread_quiet", FALSE), check.bounds = FALSE,
  warn = TRUE, soloc = tempdir(), preclean = FALSE, ...)
mread_cache(model = NULL, project = getwd(), file = paste0(model, ".cpp"),
  code = NULL, soloc = tempdir(), quiet = FALSE, preclean = FALSE, ...)
mread_file(file, ...)

Arguments

model

model name

project

location of the model specification file an any headers to be included

code

a character string with model specification code to be used instead of a model file

file

the full file name (with extension, but without path) where the model is specified

udll

use unique name for shared object

ignore.stdout

passed to system call for compiling model

raw

if TRUE, return a list of raw output

compile

logical; if TRUE, the model will be built

audit

check the model specification file for errors

quiet

don't print messages when compiling

check.bounds

check boundaries of parameter list

warn

logical; if TRUE, print warning messages that may arise

soloc

directory where model shared object is stored

preclean

logical; if TRUE, compilation artifacts are cleaned up first

...

passed along

Model Library

mrgsolve comes bundled with several precoded PK, PK/PD, and other systems models that are accessible via the mread interface.

Models available in the library include:

PK models: pk1cmt, pk2cmt, pk3cmt, pk1, pk2, popex, tmdd
PKPD models: irm1, irm2, irm3, irm4, emax, effect
Other models: viral1, viral2

When the library model is accessed, mrgsolve will compile and load the model as you would for any other model. It is only necessary to reference the correct model name and point the project argument to the mrgsolve model library location via modlib.

For more details, see modlib_pk, modlib_pkpd, modlib_tmdd, modlib_viral, and modlib_details for more information about the state variables and parameters in each model.

Details

The model argument is required. For typical use, the file argument is omitted and the value for file is generated from the value for model. To determine the source file name, mrgsolve will look for a file extension in the value of model. A file extension is assumed when it find sa period followed by one to three alpha-numeric characters at the end of the string (e.g. mymodel.txt but not my.model). If no file extension is found, the extension .cpp is assumed (e.g. file is <model-name>.cpp). If a file extension is found, file is <model-name>.

Best practice is to avoid using . in model unless you are using model to point to the model specification file name. Otherwise, use mread_file.

Examples

Run this code

# NOT RUN {
# }
# NOT RUN {
code <- '
$PARAM CL = 1, VC = 5
$CMT CENT
$ODE dxdt_CENT = -(CL/VC)*CENT;
'

mod <- mcode("ex_mread", code)

mod

mod %>% init(CENT=1000) %>% mrgsim %>% plot


mod <- mread("irm3", modlib())

mod

# if the model is in the file mymodel.cpp
mod <- mread("mymodel")

# if the model is in the file mymodel.txt
mod <- mread(file = "mymodel.txt")

or

mod <- mread_file("mymodel.txt")


# }
# NOT RUN {
# }