Table {Certara.RDarwin} | R Documentation |
Class initializer for NLME tables
Description
Creates Table class object used to specify triggers and columns for tables output.
Usage
Table(
Name = "table01.csv",
TimesList = numeric(0),
CovrSet = "",
WhenDose = "",
WhenObs = "",
VariablesList = "",
KeepSource = FALSE,
TimeAfterDose = FALSE,
IRES = FALSE,
Weight = FALSE,
IWRES = FALSE,
Mode = "all",
ForSimulation = FALSE
)
Arguments
Name |
Character; Name of the generated table. |
TimesList |
Numeric; Time values for simulation. Applicable for
time-based models only. Ignored when |
CovrSet |
Character; Vector of covariate names. Simulation point is added when the covariate value is set. |
WhenDose |
Character or logical;
Vector of dosing compartment names. Alternatively if |
WhenObs |
Character; String of observed variables names. Simulation point is added when the observation value is set. |
VariablesList |
Character; List of variables from the model for simulation. |
KeepSource |
Logical; Set to |
TimeAfterDose |
Set to |
IRES |
Logical; Set to |
Weight |
Logical; Set to |
IWRES |
Logical; Set to |
Mode |
Character; The mode of output. Options are |
ForSimulation |
Logical; Set to |
Details
If the table has a flag ForSimulation==TRUE
, it will be ignored
and won't be generated during estimation stage. Simulation stage should be
added for simulation table generation. Tables with ForSimulation==FALSE
will be ignored during simulation stage.
Value
A Table class used to store custom table information.
Examples
table01 <-
Table(Name = "table01.csv",
TimesList = seq(1,3,1),
CovrSet = "WT",
WhenDose = "A1",
WhenObs = "CObs",
VariablesList = "C",
KeepSource = FALSE,
TimeAfterDose = TRUE,
IRES = TRUE,
Weight = TRUE,
IWRES = TRUE,
ForSimulation = FALSE)