elliplot (version 1.3.0)

midpoints: Quantile Summaries

Description

Return quantile summary (minimum, quantiles, maximum) for the input data.

Usage

midpoints(x, n = 1, na.rm = TRUE)

Arguments

x

numeric, maybe including NAs and +/-Infs.

n

positive integer, to determine which quantiles to calculate. return values are \(2 ^ n + 1\) number summary. n=1 (default) is for three number, namely, minimum, median and maximum. n=2 is for five number, such as quartiles. n=3 is for nine number, such as octiles.

na.rm

logical value indicating whether NAs should be stripped before the computation proceeds.

Value

A numeric vector of length \(2 ^ n + 1\) containing the summary information.

Details

This function is calling midpoint with n depth.

References

Quantiles: median, quartiles, octiles, hexadeciles, … https://tomizonor.wordpress.com/2013/04/28/quantiles-octiles/

See Also

midpoint, seventeennum, ninenum, fivenum, median.

Examples

# NOT RUN {
midpoints(1:100, 4)
midpoints(c(rnorm(100), -Inf, Inf), 3)

# define 33 number summary
thirtythreenum <- function(x, ...) midpoints(x, 5, ...)
thirtythreenum(1:100)
# }