geomBoxplot

fun geomBoxplot(data: Map<*, *>? = null, stat: StatOptions = Stat.boxplot(), position: PosOptions = positionDodge(), showLegend: Boolean = true, inheritAes: Boolean? = null, manualKey: Any? = null, tooltips: TooltipOptions? = null, orientation: String? = null, x: Number? = null, y: Number? = null, lower: Number? = null, middle: Number? = null, upper: Number? = null, ymin: Number? = null, ymax: Number? = null, alpha: Number? = null, color: Any? = null, fill: Any? = null, size: Number? = null, stroke: Number? = null, angle: Number? = null, linetype: Any? = null, shape: Any? = null, width: Any? = null, weight: Any? = null, outlierAlpha: Number? = null, outlierColor: Any? = null, outlierFill: Any? = null, outlierShape: Any? = null, outlierSize: Number? = null, outlierStroke: Number? = null, outlierAngle: Number? = null, fatten: Number? = null, whiskerWidth: Number? = null, varWidth: Boolean? = null, coef: Number? = null, colorBy: String? = null, fillBy: String? = null, mapping: BoxplotMapping.() -> Unit = {}): FeatureList

Displays the distribution of data based on a five number summary ("minimum", first quartile (Q1), median, third quartile (Q3), and "maximum"), and "outlying" points individually.

Notes

Computed variables:

  • ..lower.. : lower hinge, 25% quantile.

  • ..middle.. : median, 50% quantile.

  • ..upper.. : upper hinge, 75% quantile.

  • ..ymin.. : lower whisker = smallest observation greater than or equal to lower hinge - 1.5 * IQR.

  • ..ymax.. : upper whisker = largest observation less than or equal to upper hinge + 1.5 * IQR.

To hide axis tooltips, set "blank" or the result of elementBlank() to the axisTooltip or axisTooltipX parameter of the theme().

Examples

Parameters

data

The data to be displayed. If null, the default, the data is inherited from the plot data as specified in the call to letsPlot.

stat

default = Stat.boxplot(). The statistical transformation to use on the data for this layer. Supported transformations: Stat.identity, Stat.bin(), Stat.count(), etc. see Stat.

position

default = positionDodge(). Position adjustment: positionIdentity, positionStack(), positionDodge(), etc. see Position.

showLegend

default = true. false - do not show legend for this layer.

inheritAes

default = true. false - do not combine the layer aesthetic mappings with the plot shared mappings.

manualKey

String or result of the call to the layerKey() function. The key to show in the manual legend. Specifies the text for the legend label or advanced settings using the layerKey() function.

tooltips

Result of the call to the layerTooltips() function. Specifies appearance, style and content. Set tooltips = tooltipsNone to hide tooltips from the layer.

orientation

Specifies the axis that the layer's stat and geom should run along. The default value (null) automatically determines the orientation based on the aesthetic mapping. If the automatic detection doesn't work, it can be set explicitly by specifying the "x" or "y" orientation.

outlierAlpha

Default transparency aesthetic for outliers.

outlierColor

Color aesthetic for outliers.

outlierFill

Fill aesthetic for outliers.

outlierShape

Shape aesthetic for outliers. For more info see: aesthetics.html#point-shapes.

outlierSize

Size aesthetic for outliers.

outlierStroke

Default width of the border for outliers.

outlierAngle

Rotation angle of the shape for outliers, in degrees.

varWidth

default = false. If false make a standard box plot. If true, boxes are drawn with widths proportional to the square-roots of the number of observations in the groups.

fatten

default = 1.0. A multiplicative factor applied to size of the middle bar.

whiskerWidth

default = 0.0. A multiplicative factor applied to the box width to draw horizontal segments on whiskers.

coef

default = 1.5. Length of the whiskers as multiple of IQR.

colorBy

default = "color" ("fill", "color", "paint_a", "paint_b", "paint_c"). Defines the color aesthetic for the geometry.

fillBy

default = "fill" ("fill", "color", "paint_a", "paint_b", "paint_c"). Defines the fill aesthetic for the geometry.

lower

Lower hinge, 25% quantile.

middle

Median, 50% quantile.

upper

Upper hinge, 75% quantile.

ymin

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

ymax

Upper whisker - the largest observation less than or equal to the upper hinge + 1.5 * IQR

width

Width of boxplot. Typically ranges between 0 and 1. Values that are greater than 1 lead to overlapping of the boxes.

alpha

Transparency level of a layer. Understands numbers between 0 and 1.

color

Color of the geometry. For more info see: aesthetics.html#color-and-fill.

fill

Fill color. For more info see: aesthetics.html#color-and-fill.

size

Lines width.

linetype

Type of the line of border. Accept codes or names (0 = "blank", 1 = "solid", 2 = "dashed", 3 = "dotted", 4 = "dotdash", 5 = "longdash", 6 = "twodash"), a hex string (up to 8 digits for dash-gap lengths), or a pattern offset to listOf(dash, gap, ...) / listOf(dash, gap, ...). For more info see: aesthetics.html#line-types.

mapping

Set of aesthetic mappings. Aesthetic mappings describe the way that variables in the data are mapped to plot "aesthetics".