Docs: Mention computed variables for non-identity statistics.

Author: ASmirnov-HORIS

plot-api/src/commonMain/kotlin/org/jetbrains/letsPlot/bistro/waterfall/WaterfallPlot.kt

@@ -3,6 +3,20 @@ package org.jetbrains.letsPlot.bistro.waterfall
 /**
  * A waterfall plot shows the cumulative effect of sequentially introduced positive or negative values.
  *
+ * ## Notes
+ *
+ * Computed variables:
+ *
+ * - ..x.. : category id.
+ * - ..xlabel.. : category name.
+ * - ..ymin.. : lower value of the change.
+ * - ..ymax.. : upper value of the change.
+ * - ..measure.. : kind of a calculation: absolute, relative or total.
+ * - ..flow_type.. : direction of the flow: increasing, decreasing, or the result (total).
+ * - ..initial.. : initial value of the change.
+ * - ..value.. : current cumsum (result of the change) or absolute value (depending on the "measure" column).
+ * - ..dy.. : value of the change.
+ *
  * ## Examples
  *
  * - [waterfall_plot.ipynb](https://nbviewer.org/github/JetBrains/lets-plot-docs/blob/master/source/kotlin_examples/cookbook/waterfall_plot.ipynb)

plot-api/src/commonMain/kotlin/org/jetbrains/letsPlot/geom/geom_area_ridges.kt

@@ -21,6 +21,16 @@ import org.jetbrains.letsPlot.tooltips.TooltipOptions
 /**
  * Plots the sum of the `y` and `height` aesthetics versus `x`. Heights of the ridges are relatively scaled.
  *
+ * ## Notes
+ *
+ * Computed variables:
+ *
+ * - ..height.. : density scaled for the ridges, according to area, counts or to a constant maximum height.
+ * - ..density.. : density estimate.
+ * - ..count.. : density * number of points.
+ * - ..scaled.. : density estimate, scaled to maximum of 1.
+ * - ..quantile.. : quantile estimate.
+ *
  * ## Examples
  *
  * - [ridgeline_plot.ipynb](https://nbviewer.org/github/JetBrains/lets-plot-docs/blob/master/source/kotlin_examples/cookbook/ridgeline_plot.ipynb)

plot-api/src/commonMain/kotlin/org/jetbrains/letsPlot/geom/geom_bar.kt

@@ -25,6 +25,17 @@ import org.jetbrains.letsPlot.tooltips.TooltipOptions
 /**
  * Displays a bar chart which makes the height of the bar proportional to the number of observed variable values, mapped to x-axis.
  *
+ * ## Notes
+ *
+ * Computed variables:
+ *
+ * - ..count.. : number of points with same x-axis coordinate.
+ * - ..sum.. : total number of points with same x-axis coordinate.
+ * - ..prop.. : groupwise proportion.
+ * - ..proppct.. : groupwise proportion in percent.
+ * - ..sumprop.. : proportion of points with same x-axis coordinate among all points in the dataset.
+ * - ..sumpct.. : proportion of points with same x-axis coordinate among all points in the dataset in percent.
+ *
  * ## Examples
  *
  * - [error_bars.ipynb](https://nbviewer.org/github/JetBrains/lets-plot-docs/blob/master/source/kotlin_examples/cookbook/error_bars.ipynb)

plot-api/src/commonMain/kotlin/org/jetbrains/letsPlot/geom/geom_bin2d.kt

@@ -26,6 +26,12 @@ import org.jetbrains.letsPlot.tooltips.TooltipOptions
  * However, this may not be the best choice when the values on the X/Y axis have significantly different magnitudes.
  * In such cases, try using `coordCartesian()`.
  *
+ * ## Notes
+ *
+ * Computed variables:
+ *
+ * - ..count.. : number of points with coordinates in the same bin.
+ *
  * ## Examples
  *
  * - [density_2d.ipynb](https://nbviewer.org/github/JetBrains/lets-plot-docs/blob/master/source/kotlin_examples/cookbook/density_2d.ipynb)

plot-api/src/commonMain/kotlin/org/jetbrains/letsPlot/geom/geom_boxplot.kt

@@ -25,6 +25,16 @@ import org.jetbrains.letsPlot.tooltips.TooltipOptions
  * 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.
  *
+ * ## Notes
+ *
+ * Computed variables:
+ *
+ * - ..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.
+ *
  * ## Examples
  *
  * - [distributions.ipynb](https://nbviewer.org/github/JetBrains/lets-plot-docs/blob/master/source/kotlin_examples/cookbook/distributions.ipynb)

plot-api/src/commonMain/kotlin/org/jetbrains/letsPlot/geom/geom_contour.kt

@@ -22,6 +22,12 @@ import org.jetbrains.letsPlot.tooltips.TooltipOptions
 /**
  * Displays contours of a 3d surface in 2d.
  *
+ * ## Notes
+ *
+ * Computed variables:
+ *
+ * - ..level.. : height of a contour.
+ *
  * ## Examples
  *
  * - [contours.ipynb](https://nbviewer.org/github/JetBrains/lets-plot-docs/blob/master/source/kotlin_examples/cookbook/contours.ipynb)

plot-api/src/commonMain/kotlin/org/jetbrains/letsPlot/geom/geom_contourf.kt

@@ -22,6 +22,12 @@ import org.jetbrains.letsPlot.tooltips.TooltipOptions
 /**
  * Fills contours of a 3d surface in 2d.
  *
+ * ## Notes
+ *
+ * Computed variables:
+ *
+ * - ..level.. : height of a contour.
+ *
  * ## Examples
  *
  * - [contours.ipynb](https://nbviewer.org/github/JetBrains/lets-plot-docs/blob/master/source/kotlin_examples/cookbook/contours.ipynb)

plot-api/src/commonMain/kotlin/org/jetbrains/letsPlot/geom/geom_count.kt

@@ -13,6 +13,14 @@ import org.jetbrains.letsPlot.tooltips.TooltipOptions
 /**
  * Sum unique values
  *
+ * ## Notes
+ *
+ * Computed variables:
+ *
+ * - ..n.. : number of points with same x-axis and y-axis coordinates.
+ * - ..prop.. : proportion of points with same x-axis and y-axis coordinates.
+ * - ..proppct.. : proportion of points with same x-axis and y-axis coordinates in percent.
+ *
  * ## Examples
  *
  * - [geom_count.ipynb](https://nbviewer.org/github/JetBrains/lets-plot-docs/blob/master/source/kotlin_examples/cookbook/geom_count.ipynb)

plot-api/src/commonMain/kotlin/org/jetbrains/letsPlot/geom/geom_density.kt

@@ -22,6 +22,15 @@ import org.jetbrains.letsPlot.tooltips.TooltipOptions
 /**
  * Displays a density estimate, which is a smoothed version of the histogram.
  *
+ * ## Notes
+ *
+ * Computed variables:
+ *
+ * - ..density.. : density estimate (mapped by default).
+ * - ..count.. : density * number of points.
+ * - ..scaled.. : density estimate, scaled to maximum of 1.
+ * - ..quantile.. : quantile estimate.
+ *
  * ## Examples
  *
  * - [distributions.ipynb](https://nbviewer.org/github/JetBrains/lets-plot-docs/blob/master/source/kotlin_examples/cookbook/distributions.ipynb)

plot-api/src/commonMain/kotlin/org/jetbrains/letsPlot/geom/geom_density2d.kt

@@ -26,6 +26,13 @@ import org.jetbrains.letsPlot.tooltips.TooltipOptions
  * However, this may not be the best choice when the values on the X/Y axis have significantly different magnitudes.
  * In such cases, try using `coordCartesian()`.
  *
+ * ## Notes
+ *
+ * Computed variables:
+ *
+ * - ..group.. : number of density estimate contour line.
+ * - ..level.. : calculated value of the density estimate for given contour line.
+ *
  * ## Examples
  *
  * - [density_2d.ipynb](https://nbviewer.org/github/JetBrains/lets-plot-docs/blob/master/source/kotlin_examples/cookbook/density_2d.ipynb)