plot-api / jetbrains.letsPlot.geom / geom_boxplot

geom_boxplot

class geom_boxplot : BoxplotAesthetics, BoxplotParameters, LayerBase

Add box plot.

Parameters

data - dictionary or pandas DataFrame, optional The data to be displayed in this layer. If None, the default, the data is inherited from the plot data as specified in the call to ggplot.

stat - string, optional The statistical transformation to use on the data for this layer, as a string. Supported transformations: "identity" (leaves the data unchanged) should be used to define boxplot from your own computations via lower, upper, ymin, ymax, middle aesthetics mappings (see below), "count" (counts number of points with same x-axis coordinate), "bin" (counts number of points with x-axis coordinate in the same bin), "smooth" (performs smoothing - linear default)

position - string, optional Position adjustment, either as a string ("identity", "stack", "dodge",...), or the result of a call to a position adjustment function.

outlierColor -

outlierFill -

outlierShape -

outlierSize -

    Default aesthetics for outliers.

varWidth -

    if FALSE (default) 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 - : number, default: 1.0 A multiplicative factor applied to size of the middle bar

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

width - width of boxplot (0..1)

alpha - transparency level of a layer Understands numbers between 0 and 1.

color - color of a geometry lines

fill - color of geometry filling

size - lines width

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

mapping - set of aesthetic mappings created by aes() function. Aesthetic mappings describe the way that variables in the data are mapped to plot "aesthetics".

Constructors

<init>

Add box plot.

geom_boxplot(data: Map<*, *>? = null, stat: StatOptions = Stat.boxplot(), position: PosOptions = Pos.dodge, showLegend: Boolean = true, sampling: SamplingOptions? = null, x: Double? = null, lower: Double? = null, middle: Double? = null, upper: Double? = null, ymin: Double? = null, ymax: Double? = null, outlierColor: Any? = null, outlierFill: Any? = null, outlierShape: Any? = null, outlierSize: Double? = null, fatten: Double? = null, varWidth: Boolean? = null, coef: Any? = null, alpha: Double? = null, color: Any? = null, fill: Any? = null, size: Double? = null, linetype: Any? = null, shape: Any? = null, width: Any? = null, mapping: BoxplotMapping.() -> Unit = {})

Properties

alpha

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

val alpha: Double?

coef

val coef: Any?

color

color of a geometry lines

val color: Any?

fatten

: number, default: 1.0 A multiplicative factor applied to size of the middle bar

val fatten: Double?

fill

color of geometry filling

val fill: Any?

linetype

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

val linetype: Any?

lower

lower hinge, 25% quantile

val lower: Double?

middle

median, 50% quantile

val middle: Double?

outlierColor

val outlierColor: Any?

outlierFill

val outlierFill: Any?

outlierShape

val outlierShape: Any?

outlierSize

    Default aesthetics for outliers.
val outlierSize: Double?

shape

val shape: Any?

size

lines width

val size: Double?

upper

upper hinge, 75% quantile

val upper: Double?

varWidth

    if FALSE (default) 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.
val varWidth: Boolean?

width

width of boxplot (0..1)

val width: Any?

x

val x: Double?

ymax

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

val ymax: Double?

ymin

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

val ymin: Double?

Functions

seal

fun seal(): Options

Extension Functions

toSpec

fun Layer.toSpec(): MutableMap<String, Any>