Certara.RDarwin (version 1.1.1)

Table: 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
)

Value

A Table class used to store custom table information.

Arguments

Name

Character; Name of the generated table.

TimesList

Numeric; Time values for simulation. Applicable for time-based models only. Ignored when keepSource=TRUE.

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 WhenDose == TRUE, triggers are added for all dosepoints for each PMLParametersSet separately; that approach is useful when different models in the set have different dosing compartments. Simulation point is added when the dose value is set.

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 TRUE to keep the number of rows appearing in the table the same as the number of rows in the input dataset.

TimeAfterDose

Set to TRUE to output time after dose.

IRES

Logical; Set to TRUE to output individual residuals. Valid only if WhenObs is specified and ForSimulation==FALSE.

Weight

Logical; Set to TRUE to output the weight of current observation. Valid only if WhenObs is specified and ForSimulation==FALSE.

IWRES

Logical; Set to TRUE to output individual weighted residuals. Valid only if WhenObs is specified and ForSimulation==FALSE.

Mode

Character; The mode of output. Options are all (default), unique, first. Only applicable to non time-based models for the case where only CovrSet is defined or the case where only CovrSet and VariablesList are defined. Since current version supports time-based models only, this argument is not applicable and won't change the output.

ForSimulation

Logical; Set to TRUE if the table should be generated during simulation, otherwise the table will be generated after fitting.

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.

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)