stat_qqboxplot {qqboxplot}

Compute values for the Q-Q Boxplot

Description

Compute values for the Q-Q Boxplot

Usage

stat_qqboxplot(
  mapping = NULL,
  data = NULL,
  geom = "qqboxplot",
  position = "dodge2",
  ...,
  coef = 1.5,
  na.rm = FALSE,
  show.legend = NA,
  inherit.aes = TRUE,
  reference_dist = "norm",
  confidence_level = 0.95,
  numboots = 500,
  qtype = 7,
  compdata = NULL
)

Arguments

mapping

Set of aesthetic mappings created by aes() or 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

specifies the geom function to use

position

Position adjustment, either as a string, or the result of a call to a position adjustment function.

...

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.

coef

Length of the whiskers as multiple of IQR. Defaults to 1.5.

na.rm

If FALSE, the default, missing values are removed with a warning. If TRUE, missing values are silently removed.

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().

reference_dist

Specifies theoretical reference distribution.

confidence_level

Sets confidence level for deviation whisker confidence bands

numboots

specifies the number of bootstrap draws for bootstrapped CIs needed only if compdata is not NULL

qtype

an integer between 1 and 9 indicating which one of the quantile algorithms to use.

compdata

specifies a data set to use as the reference distribution. If compdata is not NULL, the argument reference_dist will be ignored.

Value

Returns an object of class StatQqboxplot, (inherits from Geom, ggproto), that helps to render the data for geom_qqboxplot().

Computed variables

stat_qqboxplot() provides the following variables, some of which depend on the orientation:

width

width of boxplot

ymin or xmin

lower whisker = smallest observation greater than or equal to lower hinge - 1.5 * IQR

lower or xlower

lower hinge, 25% quantile

notchlower

lower edge of notch = median - 1.58 * IQR / sqrt(n)

middle or xmiddle

median, 50% quantile

notchupper

upper edge of notch = median + 1.58 * IQR / sqrt(n)

upper or xupper

upper hinge, 75% quantile

ymax or xmax

upper whisker = largest observation less than or equal to upper hinge + 1.5 * IQR