tangram (version 0.8.2)

nejm_iqr: Create a interquartile range cell object of the given data NEJM style

Description

Construct a cell which has the 3 interquartile ranges specified.

Usage

nejm_iqr(
  x,
  format = NA,
  na.rm = TRUE,
  names = FALSE,
  type = 8,
  msd = FALSE,
  quant = c(0.25, 0.5, 0.75),
  ...
)

Value

A cell_quantile object.

Arguments

x

numeric vector whose sample quantiles are wanted. NA and NaN values are not allowed in numeric vectors unless na.rm is TRUE.

format

numeric or character; Significant digits or fmt to pass to sprintf

na.rm

logical; if true, any NA and NaN's are removed from x before the quantiles are computed.

names

logical; if true, the result has a names attribute. Set to FALSE for speedup with many probs.

type

integer; specify algorithm to use in constructing quantile. See quantile for more information.

msd

logical; compute an msd attribute containing mean and standard deviation

quant

numeric; The quantiles to display. Should be an odd length vector, since the center value is highlighted.

...

additional arguments to constructing cell

Examples

require(stats)
nejm_iqr(rnorm(100), '3')