getBoxWhiskerMeasure: getBoxWhiskerMeasure

View source: R/boxwhisker-get-measure.R

getBoxWhiskerMeasureR Documentation

getBoxWhiskerMeasure

Description

Get a summary table of Box Whisker percentiles

Usage

getBoxWhiskerMeasure(
  data,
  dataMapping = NULL,
  y = NULL,
  group = NULL,
  quantiles = c(0.05, 0.25, 0.5, 0.75, 0.95)
)

Arguments

data

A data.frame to use for plot.

dataMapping

A BoxWhiskerDataMapping object mapping x, y and aesthetic groups to their variable names of data.

y

Name of y variable in data.

group

Name of grouping variable in data.

quantiles

Numeric values between 0 and 1 defining the quantiles to summarize

Value

A data.frame of summary statistics

Examples

# Get box-and-whisker plots of log-normal distributed data
boxData <- data.frame(x = c(rep("A", 500), rep("B", 500)), y = rlnorm(1000))

getBoxWhiskerMeasure(data = boxData, dataMapping = BoxWhiskerDataMapping$new(x = "x", y = "y"))


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