Lets-Plot-Kotlin/org.jetbrains.letsPlot.bistro.residual/residualPlot

residualPlot

fun residualPlot(data: Map<*, *>, x: String, y: String, method: String? = null, deg: Int? = null, span: Double? = null, seed: Long = ResidualPlotBuilder.SAMPLING_SEED_DEF, maxN: Int = ResidualPlotBuilder.LOESS_CRITICAL_SIZE_DEF, geom: String? = ResidualPlotBuilder.DEF_GEOM, bins: Any? = null, binWidth: Any? = null, color: String? = null, size: Number? = null, alpha: Number? = null, colorBy: String? = null, showLegend: Boolean = true, hline: Boolean = true, marginal: String = ResidualPlotBuilder.DEF_MARGINAL): Plot

Produces a residual plot that shows the difference between the observed response and the fitted response values.

Notes

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

Examples

Parameters

data

The data to be displayed.

x

Name of independent variable.

y

Name of dependent variable that will be fitted.

method

default = "lm" ("lm", "loess", "lowess", "none"). Fitting method: "lm" (Linear Model) or "loess"/"lowess" (Locally Estimated Scatterplot Smoothing). If value of deg parameter is greater than 1 then linear model becomes polynomial of the given degree. If method is "none" then data lives as is.

deg

default = 1. Degree of polynomial for linear regression model.

span

default = 0.5. Only for "loess" method. The fraction of source points closest to the current point is taken into account for computing a least-squares regression. A sensible value is usually 0.25 to 0.5.

seed

Random seed for "loess" sampling.

maxN

Maximum number of data-points for "loess" method. If this quantity exceeded random sampling is applied to data.

geom

default = "point" ("point", "tile", "none"). The geometric object to use to display the data. No object will be used if geom="none".

bins

Number or a Pair of Numbers. Number of bins in both directions, vertical and horizontal. Overridden by binWidth. If only one value given - interpret it as list of two equal values. Applicable simultaneously for "tile" geom and "histogram" marginal.

binWidth

Number or a Pair of Numbers. The width of the bins in both directions, vertical and horizontal. Overrides bins. The default is to use bin widths that cover the entire range of the data. If only one value given - interpret it as list of two equal values. Applicable simultaneously for "tile" geom and "histogram" marginal.

color

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

size

Size of a geometry.

alpha

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

colorBy

Name of grouping variable.

showLegend

default = true. false - do not show legend the main layer.

hline

default = true. false - do not show horizontal line passing through 0.

marginal

default = "dens:r". Description of marginal layers packed to string value. Different marginals are separated by the ',' char. Parameters of a marginal are separated by the ':' char.

First parameter of a marginal is a geometry name. Possible values: "dens"/"density", "hist"/"histogram", "box"/"boxplot".

Second parameter is a string specifying which sides of the plot the marginal layer will appear on. Possible values: 't' (top), 'b' (bottom), 'l' (left), 'r' (right).

Third parameter (optional) is size of marginal. To suppress marginals use marginal="none".

Examples:

  • "hist:tr:0.3",

  • "dens:tr,hist:bl",

  • "box:tr:.05, hist:bl, dens:bl".