simmodel.Rd
Executes an NLME simulation
simmodel(
model,
simParams,
params,
hostPlatform = NULL,
runInBackground = FALSE,
...
)
PK/PD model class object.
Simulation parameters. See NlmeSimulationParams
.
If missing
, default parameters generated by NlmeSimulationParams() are used.
Engine parameters. See engineParams
. The common
parameters include: sort, ODE, rtolODE, atolODE, maxStepsODE.
If missing
, default parameters generated by engineParams(model) are used.
Host definition for model execution. See hostParams
.
If missing
, simple local host is used.
Set to TRUE
to run in background and return prompt.
Additional class initializer arguments for NlmeSimulationParams
, or
arguments available inside hostParams
or engineParams
functions.
If engineParams
arguments are supplied through both params
argument
and additional argument (i.e., ellipsis), then the arguments in params
will be ignored
and only the additional arguments will be used with warning.
If hostParams
arguments are supplied through both hostPlatform
argument and additional argument, then its slots will be overridden by additional arguments.
In addition, if NlmeSimulationParams
arguments are supplied through both
simParams
argument and additional argument,
then its slots will be overridden by additional arguments.
returns job properties if runInBackground is TRUE
;
if runInBackground is FALSE
and the function is called in interactive mode,
the resulted simulated tables wil be loaded and presented as a list;
if runInBackground is FALSE
and the function is called in non-interactive mode,
the list returned will have just the full paths of the tables generated.
if (FALSE) {
SimTableObs <- tableParams(
name = "SimTableObs.csv",
timesList = "0,1,2,4,4.9,55.1,56,57,59,60",
variablesList = "C, CObs",
timeAfterDose = FALSE,
forSimulation = TRUE
)
simParams <- NlmeSimulationParams(
numReplicates = 2,
simulationTables = SimTableObs
)
# Define the model
model <- pkmodel(
numComp = 2,
absorption = "Extravascular",
ID = "Subject",
Time = "Act_Time",
CObs = "Conc",
Aa = "Amount",
data = pkData,
modelName = "PkModel"
)
results <- simmodel(model, simParams)
# with seed given additionally:
results <- simmodel(model, simParams, seed = 3527)
}