geomSmooth

class geomSmooth(val data: Map<*, *>? = null, val stat: StatOptions = Stat.smooth(), 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 orientation: String? = null, val x: Number? = null, val y: Number? = null, val ymin: Number? = null, val ymax: Number? = null, val size: Number? = null, val linetype: Any? = null, val color: Any? = null, val fill: Any? = null, val alpha: Number? = null, val method: String? = null, val n: Int? = null, val level: Number? = null, val se: Boolean? = null, val span: Number? = null, val deg: Int? = null, val seed: Long? = null, val maxN: Int? = null, val colorBy: String? = null, val fillBy: String? = null, mapping: SmoothMapping.() -> Unit = {}) : Layer, SmoothAesthetics, SmoothStatParameters, WithColorOption, WithFillOption

Adds a smoothed conditional mean.

Notes

geomSmooth() aids the eye in seeing patterns in the presence of overplotting.

Computed variables:

  • ..y.. : predicted (smoothed) value.

  • ..ymin.. : lower pointwise confidence interval around the mean.

  • ..ymax.. : upper pointwise confidence interval around the mean.

  • ..se.. : standard error.

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 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.smooth(). 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.

orientation

Specifies the axis that the layer's stat and geom should run along, default = "x". Possible values: "x", "y".

x

X-axis value.

y

Predicted (smoothed) value.

ymin

Lower pointwise confidence interval around the mean.

ymax

Upper pointwise confidence interval around the mean.

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

Filling color for the confidence interval around the line. For more info see: aesthetics.html#color-and-fill.

size

Lines width. Defines line width for conditional mean and confidence bounds lines.

linetype

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

method

default = "lm". Smoothing method: lm (Linear Model) or loess (Locally Estimated Scatterplot Smoothing).

n

default = 80. Number of points to evaluate smoother at.

se

default = true. To display confidence interval around smooth.

level

default = 0.95. Level of confidence interval to use.

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.

deg

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

seed

Random seed for LOESS sampling.

maxN

default = 1000. Maximum number of data-points for LOESS method. If this quantity exceeded random sampling is applied to data.

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".

Constructors

Link copied to clipboard
constructor(data: Map<*, *>? = null, stat: StatOptions = Stat.smooth(), position: PosOptions = positionIdentity, showLegend: Boolean = true, inheritAes: Boolean? = null, manualKey: Any? = null, sampling: SamplingOptions? = null, tooltips: TooltipOptions? = null, orientation: String? = null, x: Number? = null, y: Number? = null, ymin: Number? = null, ymax: Number? = null, size: Number? = null, linetype: Any? = null, color: Any? = null, fill: Any? = null, alpha: Number? = null, method: String? = null, n: Int? = null, level: Number? = null, se: Boolean? = null, span: Number? = null, deg: Int? = null, seed: Long? = null, maxN: Int? = null, colorBy: String? = null, fillBy: String? = null, mapping: SmoothMapping.() -> Unit = {})

Properties

Link copied to clipboard
open override val alpha: Number? = null
Link copied to clipboard
open override val color: Any? = null
Link copied to clipboard
open override val colorBy: String? = null
Link copied to clipboard
val data: Map<*, *>? = null
Link copied to clipboard
open override val deg: Int? = null
Link copied to clipboard
open override val fill: Any? = null
Link copied to clipboard
open override val fillBy: String? = null
Link copied to clipboard
val geom: GeomOptions
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open override val level: Number? = null
Link copied to clipboard
open override val linetype: Any? = null
Link copied to clipboard
val manualKey: Any? = null
Link copied to clipboard
val mapping: <Error class: unknown class>
Link copied to clipboard
open override val maxN: Int? = null
Link copied to clipboard
open override val method: String? = null
Link copied to clipboard
open override val n: Int? = null
Link copied to clipboard
val orientation: String? = null
Link copied to clipboard
val parameters: <Error class: unknown class>
Link copied to clipboard
val position: PosOptions?
Link copied to clipboard
val sampling: SamplingOptions? = null
Link copied to clipboard
open override val se: Boolean? = null
Link copied to clipboard
open override val seed: Long? = null
Link copied to clipboard
Link copied to clipboard
open override val size: Number? = null
Link copied to clipboard
open override val span: Number? = null
Link copied to clipboard
val stat: StatOptions
Link copied to clipboard
Link copied to clipboard
open override val x: Number? = null
Link copied to clipboard
open override val y: Number? = null
Link copied to clipboard
open override val ymax: Number? = null
Link copied to clipboard
open override val ymin: Number? = null