geom_half_boxplot ¶

Half of a box-and-whisker plot, on one side of each x.

As geom_half_boxplot in the R package gghalves: the box runs from its outer edge to x (less nudge), the whiskers stand at x (moved nudge towards the box), with fences reaching outwards. With the default stat, a second point layer (stat="boxplot_outlier") draws the outliers beside the whiskers, as geom_boxplot does.

Parameters:

• mapping (FeatureSpec, default: None ) –

  Aesthetic mapping from aes(). Needs x and y.

• data (DataFrame or dict, default: None ) –

  Layer data; inherits the plot data when None.

• stat (str, default: None ) –

  Statistical transformation, by name; "boxplot" by default.

• position (str or FeatureSpec, default: None ) –

  Position adjustment; "dodge" (by the box width) by default.

• show_legend (bool, default: None ) –

  False hides this layer from the legend.

• inherit_aes (bool, default: None ) –

  False ignores the plot's default mapping for this layer.

• manual_key (str or FeatureSpec, default: None ) –

  This layer's key in a manual legend: a label, or layer_key().

• tooltips (FeatureSpec or list of str, default: None ) –

  Tooltip content: layer_tooltips(), a list of column names, or "none".

• orientation (str, default: None ) –

  "y" draws along the y axis; a discrete y with a continuous x picks it.

• side ((l, r), default: "l" ) –

  The side of x the half box is drawn on.

• nudge (float, default: 0 ) –

  Distance (data units) between x and the box's inner edge, and the whiskers' shift towards the box.

• errorbar_draw (bool, default: True ) –

  Draw fences at the whisker ends.

• errorbar_length (float, default: 0.5 ) –

  Fence length as a share of the half box, from 0 to 1.

• fatten (float, default: 2 ) –

  Multiplier of the median line width.

• outlier_alpha (optional, default: None ) –

  Style of the outlier points (also outlier_shape, outlier_size, outlier_stroke); color, fill, shape, size and stroke in other_args are the fallback.

• outlier_color (optional, default: None ) –

  Style of the outlier points (also outlier_shape, outlier_size, outlier_stroke); color, fill, shape, size and stroke in other_args are the fallback.

• outlier_fill (optional, default: None ) –

  Style of the outlier points (also outlier_shape, outlier_size, outlier_stroke); color, fill, shape, size and stroke in other_args are the fallback.

• outlier_shape (int or str, default: None ) –

  Shape of the outlier points.

• outlier_size (float, default: None ) –

  Size of the outlier points.

• outlier_stroke (float, default: None ) –

  Stroke width of the outlier points.

• color_by (str, default: None ) –

  Aesthetic the color scale applies to ("color" or "fill").

• fill_by (str, default: None ) –

  Aesthetic the fill scale applies to ("fill" or "color").

• na_rm (bool, default: None ) –

  True removes rows with missing values silently.

• **other_args (Any) –

  Constant aesthetics, width (default 0.75) and coef.

Returns:

• LayerSpec or FeatureSpecArray –

  The box layer, plus the outlier layer with the default stat.

Raises:

• SpecError –

  If side is not "l" or "r", or errorbar_length is outside [0, 1].

• UnsupportedValueError –

  If nudge or errorbar_length is not a number.

Examples:

>>> from ggrust import *
>>> data = {"diet": ["veg"] * 6 + ["meat"] * 6,
...         "weight": [61, 58, 66, 70, 63, 59, 72, 80, 77, 69, 85, 74]}
>>> plot = (ggplot(data, aes("diet", "weight"))
...         + geom_half_boxplot(side="r") + geom_half_point(side="l"))