HistogramDataMapping: HistogramDataMapping

In Open-Systems-Pharmacology/TLF-Library: TLF Library

HistogramDataMapping

Description

R6 class for mapping x, bins, binwidth,stack and distribution to data

Super classes

tlf::XYDataMapping -> tlf::XYGDataMapping -> HistogramDataMapping

Public fields

frequency

logical defining if histogram displays a frequency in y axis

stack

logical defining if histogram bars should be stacked

bins

number of bins or binning values/methods passed on ggplot2::geom_histogram

binwidth

width of bins passed on ggplot2::geom_histogram. Overwrites bins

distribution

Name of distribution to fit to the data. Only 2 distributions are currently available: "normal" and "logNormal"

Methods

Public methods

• HistogramDataMapping$new()

• HistogramDataMapping$clone()

Inherited methods

• tlf::XYGDataMapping$checkMapData()

---

Method new()

Create a new HistogramDataMapping object

Usage

HistogramDataMapping$new(
  frequency = FALSE,
  stack = FALSE,
  bins = NULL,
  binwidth = NULL,
  distribution = NULL,
  ...
)

Arguments

frequency

logical defining if histogram displays a frequency in y axis

stack

logical defining if histogram bars should be stacked

bins

argument passed on ggplot2::geom_histogram

binwidth

width of bins passed on ggplot2::geom_histogram. Overwrites bins

distribution

Name of distribution to fit to the data. Only 2 distributions are currently available: "normal" and "logNormal"

...

parameters inherited from XYGDataMapping

Returns

A new HistogramDataMapping object

---

Method clone()

The objects of this class are cloneable with this method.

Usage

HistogramDataMapping$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

See Also

Other DataMapping classes: BoxWhiskerDataMapping, CumulativeTimeProfileDataMapping, DDIRatioDataMapping, GroupMapping, Grouping, 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.