Lets-Plot-Kotlin/org.jetbrains.letsPlot.geom/geomQQLine

geomQQLine

class geomQQLine(val data: Map<*, *>? = null, val stat: StatOptions = Stat.qqLine(), val position: PosOptions = positionIdentity, val showLegend: Boolean = true, val inheritAes: Boolean? = null, val manualKey: Any? = null, val sampling: SamplingOptions? = null, val tooltips: TooltipOptions? = null, val sample: Number? = null, val alpha: Number? = null, val color: Any? = null, val linetype: Any? = null, val size: Number? = null, val distribution: String? = null, val dParams: List<Number>? = null, val quantiles: <Error class: unknown class><Number, Number>? = null, val colorBy: String? = null, mapping: QQLineMapping.() -> Unit = {}) : Layer, QQLineAesthetics, QQStatAesthetics, QQLineStatParameters, WithColorOption

Displays quantile-quantile fitting line.

Notes

The Q-Q line plot is used for comparing two probability distributions (sample and theoretical) by plotting line passed through the pair of corresponding quantiles.

Computed variables:

..theoretical.. : theoretical quantiles.
..sample.. : sample quantiles.

Examples

qq_plots.ipynb

Parameters

data

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

stat

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

position

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.

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.

tooltips

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

distribution

default = "norm". Distribution function to use: "norm", "uniform", "t", "gamma", "exp", "chi2".

dParams

Additional parameters passed on to distribution function.

If distribution is "norm" then dParams is a pair (mean, std) (default = listOf(0.0, 1.0)).
If distribution is "uniform" then dParams is a pair (a, b) (default = listOf(0.0, 1.0)).
If distribution is "t" then dParams is an integer number (d) (default = listOf(1)).
If distribution is "gamma" then dParams is a pair (alpha, beta) (default = listOf(1.0, 1.0)).
If distribution is "exp" then dParams is a float number (lambda) (default = listOf(1.0)).
If distribution is "chi2" then dParams is an integer number (k) (default = listOf(1)).

quantiles

default = 0.25, 0.75. Pair of quantiles to use when fitting the Q-Q line.

colorBy

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

sample

Y-axis value.

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.

linetype

Type of the line. 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.

size

Line width.

mapping

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

Constructors

geomQQLine

constructor(data: Map<*, *>? = null, stat: StatOptions = Stat.qqLine(), position: PosOptions = positionIdentity, showLegend: Boolean = true, inheritAes: Boolean? = null, manualKey: Any? = null, sampling: SamplingOptions? = null, tooltips: TooltipOptions? = null, sample: Number? = null, alpha: Number? = null, color: Any? = null, linetype: Any? = null, size: Number? = null, distribution: String? = null, dParams: List<Number>? = null, quantiles: <Error class: unknown class><Number, Number>? = null, colorBy: String? = null, mapping: QQLineMapping.() -> Unit = {})