stat_boxplot_custom: A box and whiskers plot that uses percentiles instead of IQR

In BoulderCodeHub/CRSSIO: Package to Manage the Input and Output of CRSS Data

A box and whiskers plot that uses percentiles instead of IQR

Description

stat_boxplot_custom() modifies ggplot2::stat_boxplot() so that it computes the extents of the whiskers based on specified percentiles, rather than a multiple of the IQR.

Usage

stat_boxplot_custom(
  mapping = NULL,
  data = NULL,
  geom = "boxplot",
  position = "dodge2",
  ...,
  qs = c(0.05, 0.25, 0.5, 0.75, 0.95),
  na.rm = FALSE,
  orientation = NA,
  show.legend = NA,
  inherit.aes = TRUE
)

Arguments

mapping	Set of aesthetic mappings created by aes(). If specified and inherit.aes = TRUE (the default), it is combined with the default mapping at the top level of the plot. You must supply mapping if there is no plot mapping.
data	The data to be displayed in this layer. There are three options: If NULL, the default, the data is inherited from the plot data as specified in the call to ggplot(). A data.frame, or other object, will override the plot data. All objects will be fortified to produce a data frame. See fortify() for which variables will be created. A function will be called with a single argument, the plot data. The return value must be a data.frame, and will be used as the layer data. A function can be created from a formula (e.g. ~ head(.x, 10)).
geom	Available, but should only be 'boxplot'.
position	Position adjustment, either as a string naming the adjustment (e.g. "jitter" to use position_jitter), or the result of a call to a position adjustment function. Use the latter if you need to change the settings of the adjustment.
...	Other arguments passed on to layer(). These are often aesthetics, used to set an aesthetic to a fixed value, like colour = "red" or size = 3. They may also be parameters to the paired geom/stat.
qs	The percentiles that are used to create the lower whisker, lower hinge, middle bar, upper hinge, and upper whisker, respectively. The lower and upper whiskers default to the 5th and 95th percentiles. The hinges default to the 25th and 75th percentiles, and the middle bar defaults to the median. These values should be in increasing order, i.e., the whisker should be a smaller percentile than the lower hinge, and can only span the values from 0 to 1 (inclusive).
na.rm	If FALSE, the default, missing values are removed with a warning. If TRUE, missing values are silently removed.
orientation	The orientation of the layer. The default (NA) automatically determines the orientation from the aesthetic mapping. In the rare event that this fails it can be given explicitly by setting orientation to either "x" or "y". See the Orientation section for more detail.
show.legend	logical. Should this layer be included in the legends? NA, the default, includes if any aesthetics are mapped. FALSE never includes, and TRUE always includes. It can also be a named logical vector to finely select the aesthetics to display.
inherit.aes	If FALSE, overrides the default aesthetics, rather than combining with them. This is most useful for helper functions that define both data and aesthetics and shouldn't inherit behaviour from the default plot specification, e.g. borders().

Details

The upper and lower whiskers extend to the first, and last entries of the qs parameter, respectively. Data beyond the whiskers are "outliers".

Examples

library(ggplot2)
p <- ggplot(mpg, aes(class, hwy))

# show whiskers at 5th and 95th percentiles
p + stat_boxplot_custom(qs = c(.05, .25, .5, .75, .95))

# show whiskers at 10th and 90th percentiles
p + stat_boxplot_custom(qs = c(.1, .25, .5, .75, .9))

BoulderCodeHub/CRSSIO documentation built on July 2, 2023, 5:15 p.m.