Certara.RDarwin (version 1.2.0)

add_Dosepoint: Add Dosepoint in PML models

Description

Add Dosepoint in PML models

Usage

add_Dosepoint(
  PMLParametersSets,
  DosepointName = "A1",
  State = "Present",
  tlag = c(),
  bioavail = c(),
  duration = c(),
  rate = c(),
  PMLStructures = NULL
)

Value

An updated list of PML models (PMLModels class instance) matching the specified options.

Arguments

PMLParametersSets

A list of PML parameters sets (PMLModels class instance).

DosepointName

A character string giving the name of the Dosepoint.

State

A character string giving the state of the Dosepoint, must be one of "None", "Present", "Searched". Default is "Present".

tlag

An optional parameter for the time lag. Can be an StParm object, an Expression object, or a character string (which will be converted to an Expression).

bioavail

An optional parameter for bioavailability. Can be an StParm object, an Expression object, or a character string (which will be converted to an Expression).

duration

An optional parameter for the duration of infusion. Can be an StParm object, an Expression object, or a character string (which will be converted to an Expression).

rate

An optional parameter for the rate of infusion. Can be an StParm object, an Expression object, or a character string (which will be converted to an Expression).

PMLStructures

Character or character vector specifying names of PML structures in which the dosepoint statement will be modified. For the naming convention of PMLStructures, see Details section of get_PMLParametersSets().

See Also

list_Dosepoints(), modify_Dosepoint()

Functions used for Dosepoint specification: Dosepoint(), create_ModelPK(), modify_Dosepoint()

Examples

PMLParametersSets <-
  create_ModelPK(CompartmentsNumber = c(1, 2, 3),
                 Absorption = c("First-Order"))

# modify dosepoint
PMLParametersSets <-
  modify_Dosepoint(PMLParametersSets,
                   DosepointName = "Aa",
                   tlag = StParm(StParmName = "Tlag",
                                 State = "Present"),
                   bioavail = StParm(StParmName = "F",
                                     State = "Present"))

# add dosepoint
PMLParametersSets <-
 add_Dosepoint(PMLParametersSets,
               DosepointName = "A1",
               bioavail = Expression("1 - F"),
               duration = Expression("Tlag"))