get_boxplot_range_1d: Create data ranges based boxplots statistics and outliers

Description Usage Arguments Details Value Author(s) Examples

View source: R/get_boxplot_range_1d.R

Description

Take a vector of data and returns the bounds corresponding the boxplot specifications.

Usage

1
get_boxplot_range_1d(x, split_IQR = TRUE, na.rm = TRUE, type = 5, ...)

Arguments

x

numeric. A vector from which the ranges are to be derived based on quantiles. NA and NaN values are not allowed unless na.rm is TRUE.

split_IQR

logical. Should the inter-quartile range be split at the median to form different ranges? The default is TRUE

na.rm

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

type

an integer between 1 and 9 selecting one of the nine quantile algorithms detailed below to be used.

...

further arguments passed to or from other methods.

Details

The ranges are bounded by the lower outlier (if any), extreme of the lower whisker, the lower ‘hinge’, the median, the upper ‘hinge’, the extreme of the upper whisker, and the upper outlier (if any).

Value

A numeric vector containing the bounds labelled as out_min (the lower outlier), ymin (the extreme of the lower whisker), lower (the lower ‘hinge’), middle (the median), upper (the upper ‘hinge’), ymax (the extreme of the upper whisker), out_max (the upper outlier).

Author(s)

Issoufou Liman

Examples

1
2
sample <- rnorm(100)
get_boxplot_range_1d (sample)

Issoufou-Liman/decisionSupportExtra documentation built on Dec. 21, 2020, 6:28 p.m.