addDoseCycle: Adds a dosing cycle to model

In Certara.RsNLME: Pharmacometric Modeling

Adds a dosing cycle to model

Description

Add Steady State or ADDL dosing cycle to model object.

Usage

addDoseCycle(
  .Object,
  type = "SteadyState",
  name,
  administration = "Bolus",
  amount = NULL,
  II = NULL,
  rate = NULL,
  duration = NULL,
  isSecondDose = FALSE,
  colName = NULL
)

Arguments

.Object	Model object
type	Specification of dose type. Options are "SteadyState"and "ADDL"
name	Dose point name. See doseNames
administration	Mechanism for administering dose. Options are "Bolus" or "Infusion"
amount	Optional. Column mapping argument specifying corresponding "ADDL" column in input data, or numeric value specifiying dose amount.
II	Optional. Column mapping argument specifying corresponding "II" column in input data, or numeric value specifying delta time.
rate	Optional. Column mapping argument specifying corresponding "Rate" column in input data, or numeric specifying dose rate.
duration	Optional. Column mapping argument specifying corresponding "Duration" column in data, or numeric specifying duration value.
isSecondDose	Use second dose point on compartment
colName	Column name in input data corresponding to column mapping for "SteadyState" or "ADDL" as supplied in type argument.

Value

Modified NlmePmlModel object

See Also

doseNames

Examples

model <- pkmodel(columnMap = FALSE) %>%
  addDoseCycle(type = "SteadyState", name = "A1", amount = "Amount", II = "II")

Certara.RsNLME documentation built on April 3, 2025, 11:04 p.m.