statBoxplot

fun statBoxplot(data: Map<*, *>? = null, geom: GeomOptions = Geom.boxplot(), position: PosOptions = positionDodge(), showLegend: Boolean = true, sampling: SamplingOptions? = 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, linetype: Any? = null, shape: Any? = null, angle: Number? = null, width: Any? = null, weight: Any? = null, outlierAlpha: Number? = null, outlierColor: Any? = null, outlierFill: Any? = null, outlierShape: Any? = null, outlierAngle: Number? = null, outlierSize: Number? = null, outlierStroke: 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.

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.

geom

The geometry to display the boxplot stat for this layer, default is Geom.boxplot(), see Geom.

position

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

showLegend

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

sampling

Result of the call to the samplingXxx() function. To prevent any sampling for this layer pass value samplingNone. For more info see sampling.html.

x

X-axis value.

y

Y-axis value.

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

alpha

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

color

Color of the geometry. String in the following formats:

  • RGB/RGBA (e.g. "rgb(0, 0, 255)")

  • HEX (e.g. "#0000FF")

  • color name (e.g. "red")

  • role name ("pen", "paper" or "brush")

Or an instance of the java.awt.Color class.

fill

Fill color. String in the following formats:

  • RGB/RGBA (e.g. "rgb(0, 0, 255)")

  • HEX (e.g. "#0000FF")

  • color name (e.g. "red")

  • role name ("pen", "paper" or "brush")

Or an instance of the java.awt.Color class.

size

Lines width and outliers size.

stroke

Width of the outlier shape border. Applied only to the shapes having border.

linetype

Type of the line of border. Codes and names: 0 = "blank", 1 = "solid", 2 = "dashed", 3 = "dotted", 4 = "dotdash", 5 = "longdash", 6 = "twodash".

shape

Shape of the outliers.

width

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

outlierAlpha

Default transparency aesthetic for outliers.

outlierColor

Color aesthetic for outliers.

outlierFill

Fill aesthetic for outliers.

outlierShape

Shape aesthetic for outliers.

outlierSize

Size aesthetic for outliers.

outlierStroke

Default width of the border for outliers.

outlierAngle

Rotation angle of the shape for outliers, in degrees.

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.

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.

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.

mapping

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