DDIRatioDataMapping: DDIRatioDataMapping

DDIRatioDataMappingR Documentation

DDIRatioDataMapping

Description

R6 class for mapping x, y, GroupMapping and DDI ratio lines variables to data

Super classes

tlf::XYDataMapping -> tlf::XYGDataMapping -> tlf::PKRatioDataMapping -> DDIRatioDataMapping

Active bindings

deltaGuest

Value of delta in Guest et al. equation

minRange

Minimum range of x values for guest and ratio lines

residualsVsObserved

Logical defining if calculated DDI data are as residuals vs observed or predicted vs observed

Methods

Public methods

Inherited methods

Method new()

Create a new DDIRatioDataMapping object

Usage
DDIRatioDataMapping$new(
  deltaGuest = NULL,
  minRange = c(0.01, 100),
  lines = DefaultDataMappingValues$ddiRatio,
  residualsVsObserved = FALSE,
  ...
)
Arguments
deltaGuest

Value of delta in Guest et al. equation. Default value is 1.

minRange

Minimum range of x values for guest and ratio lines Default is [0.01 - 100]

lines

List of ratio limits to display as diagonal/horizontal lines

residualsVsObserved

Logical defining if calculated DDI data are as residuals vs observed or predicted vs observed

...

parameters inherited from PKRatioDataMapping

Returns

A new DDIRatioDataMapping object


Method clone()

The objects of this class are cloneable with this method.

Usage
DDIRatioDataMapping$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

See Also

Other DataMapping classes: BoxWhiskerDataMapping, CumulativeTimeProfileDataMapping, GroupMapping, Grouping, HistogramDataMapping, ObsVsPredDataMapping, ObservedDataMapping, PKRatioDataMapping, PieChartDataMapping, QQDataMapping, RangeDataMapping, ResVsPredDataMapping, ResVsTimeDataMapping, TimeProfileDataMapping, TornadoDataMapping, XYDataMapping, XYGDataMapping


Open-Systems-Pharmacology/TLF-Library documentation built on Feb. 8, 2025, 11:22 a.m.