Skip to content

Commit 9045493

Browse files
Documentation for v4.12.0 (#293)
1 parent c562791 commit 9045493

37 files changed

+136629
-139701
lines changed
244 KB
Loading
181 KB
Loading
104 KB
Loading
101 KB
Loading

Writerside/topics/aesthetics.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,16 @@
44

55
![Point shapes](aesthetics_shape.png)
66

7+
See [example notebook](%nb-aesthetics-point_shapes%).
8+
79
## Line Types
810

911
### Predefined Patterns
1012

1113
![Predefined line types](aesthetics_linetype.png)
1214

15+
See [example notebook](%nb-aesthetics-line_types-predefined_patterns%).
16+
1317
### Custom Patterns
1418

1519
Ways to specify the `linetype`:
@@ -20,6 +24,8 @@ Ways to specify the `linetype`:
2024

2125
![Custom line types](aesthetics_custom_linetype.png)
2226

27+
See [example notebook](%nb-aesthetics-line_types-custom_patterns%).
28+
2329
## Text
2430

2531
### Font Family
@@ -32,12 +38,16 @@ The default font family is `'sans'`.
3238

3339
You can also use the name of any other font installed on your system (e.g. `"Times New Roman"`).
3440

41+
See [example notebook](%nb-aesthetics-text_style-font_family%).
42+
3543
### Font Face
3644

3745
![Font faces](aesthetics_font_face.png)
3846

3947
The default font face is `'plain'`.
4048

49+
See [example notebook](%nb-aesthetics-text_style-font_face%).
50+
4151
## Color and Fill
4252

4353
Colors and fills of geometries can be specified in the following ways:
@@ -64,4 +74,6 @@ Colors and fills of geometries can be specified in the following ways:
6474
</li>
6575
</list>
6676

67-
- An instance of the `java.awt.Color` class.
77+
- An instance of the `java.awt.Color` class.
78+
79+
See [example notebook](%nb-aesthetics-system_colors%).

Writerside/topics/charts.md

Lines changed: 33 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,14 @@ You can pass tidy data to *Lets-Plot* in form of a Kotlin `Map`.
2222

2323
- <a href="aesthetics.md#text">Text</a>
2424

25+
Cookbooks:
26+
27+
- [Point shapes](%nb-aesthetics-point_shapes%)
28+
- [Line types](%nb-aesthetics-line_types%)
29+
- [System colors](%nb-aesthetics-system_colors%)
30+
- [Text](%nb-aesthetics-text_style%)
31+
- [Overriding default grouping with the group aesthetic](%nb-group_override_defaults%)
32+
2533
## Basic Building Blocks
2634

2735
Points:
@@ -59,9 +67,9 @@ Text:
5967
[`label`](%api_geom%/geom-label/index.html),
6068
[`label repel`](%api_geom%/geom-label-repel/index.html)
6169

62-
Examples:
70+
Cookbooks:
6371

64-
- [Inset map of Kotlin island](%nb-spatialdataset_kotlin_isl%)
72+
- [Missing values: line, path, area, and ribbon](%nb-missing_values_line_path_area_ribbon%)
6573
- [Drawing graph edges](%nb-graph_edges%)
6674
- [Formatting labels on plots](%nb-formatting_axes_etc%)
6775
- [Text geoms](%nb-text_geoms%)
@@ -77,6 +85,10 @@ Examples:
7785
- [`stroke` aesthetic](%nb-aes_stroke%)
7886
- [Configuring nudge units in position adjustments](%nb-position_nudge_unit%)
7987

88+
Demos:
89+
90+
- [Inset map of Kotlin island](%nb-spatialdataset_kotlin_isl%)
91+
8092

8193
## Discrete
8294

@@ -89,7 +101,7 @@ Examples:
89101
Learn more:
90102
<a href="as_discrete.md">Working with Categorical Variables and the <format style="bold">asDiscrete()</format> Function</a>
91103

92-
Examples:
104+
Cookbooks:
93105

94106
- [Barchart](%nb-bar%)
95107
- [Pie-chart](%nb-geom_pie%)
@@ -109,7 +121,7 @@ Examples:
109121
[`contours`](%api_geom%/geom-contour/index.html),
110122
[`filled contours`](%api_geom%/geom-contour-filled/index.html)
111123

112-
Examples:
124+
Cookbooks:
113125

114126
- [Contours](%nb-contours%)
115127

@@ -125,7 +137,7 @@ Examples:
125137
[`ridgeline`](%api_geom%/geom-area-ridges/index.html),
126138
[`frequency polygon`](%api_geom%/geom-freqpoly/index.html)
127139

128-
Examples:
140+
Cookbooks:
129141

130142
- [Distributions](%nb-distributions%)
131143
- [Dotplot geometry](%nb-geom_dotplot%)
@@ -143,7 +155,7 @@ Examples:
143155
[`statSummary()`](%api_stat%/stat-summary/index.html),
144156
[`statSummaryBin()`](%api_stat%/stat-summary-bin/index.html)
145157

146-
Examples:
158+
Cookbooks:
147159

148160
- [ECDF stat](%nb-stat_ecdf%)
149161
- [Summary stat](%nb-stat_summary%)
@@ -154,7 +166,7 @@ Examples:
154166

155167
[`function`](%api_geom%/geom-function/index.html)
156168

157-
Examples:
169+
Cookbooks:
158170

159171
- [Function geometry](%nb-geom_function%)
160172

@@ -166,7 +178,7 @@ Examples:
166178
[`linerange`](%api_geom%/geom-line-range/index.html),
167179
[`pointrange`](%api_geom%/geom-point-range/index.html)
168180

169-
Examples:
181+
Cookbooks:
170182

171183
- [Plotting means and error ranges](%nb-error_bars%)
172184
- [Geometries with dual orientation](%nb-horizontal_geoms%)
@@ -176,7 +188,7 @@ Examples:
176188

177189
[`smoothing line`](%api_geom%/geom-smooth/index.html)
178190

179-
Examples:
191+
Cookbooks:
180192

181193
- [Smoothing](%nb-geom_smooth%)
182194
- [Draw a scatter plot](%nb-scatter_plot%)
@@ -187,12 +199,14 @@ Examples:
187199
[`2d bins`](%api_geom%/geom-bin2-d/index.html),
188200
[`2d hexagonal bins`](%api_geom%/geom-hex/index.html),
189201
[`2d density`](%api_geom%/geom-density2-d/index.html),
190-
[`filled 2d density`](%api_geom%/geom-density2-d-filled/index.html)
202+
[`filled 2d density`](%api_geom%/geom-density2-d-filled/index.html),
203+
[`pointdensity`](%api_geom%/geom-point-density/index.html)
191204

192-
Examples:
205+
Cookbooks:
193206

194207
- [2d density](%nb-density_2d%)
195208
- [Hexagonal heatmap](%nb-geom_hex%)
209+
- [Pointdensity geometry](%nb-geom_pointdensity%)
196210
- [Absolute unit specification for width and height aesthetics](%nb-param_width_unit%)
197211

198212

@@ -202,7 +216,7 @@ Examples:
202216

203217
See also: [Joint Plot](bistro.md#joint-plot), [Residual Plot](bistro.md#residual-plot).
204218

205-
Examples:
219+
Cookbooks:
206220

207221
- [Marginal plots](%nb-marginal_layers%)
208222

@@ -239,18 +253,21 @@ This is in contrast to R's ggplot2, which provides separate "date", "time", and
239253

240254
- `Date`
241255

242-
Examples:
256+
Cookbooks:
243257

244258
- [Scale time](%nb-scale_time%)
245259
- [Plotting time series](%nb-time_date_datetime%)
260+
261+
Demos:
262+
246263
- [Bitcoin daily trend visualization](%nb-trading_chart%)
247264

248265

249266
## Images
250267

251268
[`geomImshow()`](%api_geom%/geom-imshow.html)
252269

253-
Examples:
270+
Cookbooks:
254271

255272
- [`geomImshow()`](%nb-image_101%)
256273
- [The `extent` parameter](%nb-image_extent%)
@@ -266,7 +283,7 @@ Examples:
266283
[`coordFlip()`](%api_coord%/coord-flip.html),
267284
[`coordMap()`](%api_coord%/coord-map.html)
268285

269-
Examples:
286+
Cookbooks:
270287

271288
- [Flipped coordinates](%nb-coord_flip%)
272289
- [Polar coordinate system](%nb-coord_polar%)
@@ -279,7 +296,7 @@ Examples:
279296
[`guides()`](%api_scale%/guides.html),
280297
[`layerKey()`](%api_scale%/layer-key.html)
281298

282-
Examples:
299+
Cookbooks:
283300

284301
- [Legend customization](%nb-legend%)
285302
- [Manual legend](%nb-manual_legend%)

Writerside/topics/geospatial_charts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ The *Lets-Plot* library recognizes the following three 2D-geometry types:
3232

3333
These shapes can be plotted using various geometry layers that depend on the type of the shape:
3434

35-
- Points : [`geomPoint`](%api_geom%/geom-point/index.html), [`geomText`](%api_geom%/geom-text/index.html), [`geomLabel`](%api_geom%/geom-label/index.html), [`geomPie`](%api_geom%/geom-pie/index.html)
35+
- Points : [`geomPoint`](%api_geom%/geom-point/index.html), [`geomText`](%api_geom%/geom-text/index.html), [`geomLabel`](%api_geom%/geom-label/index.html), [`geomPointDensity`](%api_geom%/geom-point-density/index.html), [`geomPie`](%api_geom%/geom-pie/index.html)
3636
- Lines : [`geomPath`](%api_geom%/geom-path/index.html)
3737
- Polygons : [`geomPolygon`](%api_geom%/geom-polygon/index.html), [`geomMap`](%api_geom%/geom-map/index.html). [`geomRect`](%api_geom%/geom-rect/index.html) when used with Polygon shapes displays corresponding bounding boxes.
3838

Writerside/topics/multiplot.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,24 +5,28 @@
55
- [`facetGrid()`](%api_facet%/facet-grid.html) - split data by one or two variables that vary in the X and/or Y direction.
66
- [`facetWrap()`](%api_facet%/facet-wrap.html) - split data by one or more variables with extra flexibility.
77

8-
Examples:
8+
Cookbooks:
99

1010
- [Multipanel plots with facets](%nb-facets%)
1111

1212
## `ggbunch`
1313

1414
- [`ggbunch`](%api_lets_plot%/ggbunch.html) - create a collection of plots that can have arbitrary location and size.
1515

16-
Examples:
16+
Cookbooks:
1717

18-
- [Inset map of Kotlin island](%nb-spatialdataset_kotlin_isl%)
1918
- [The `ggbunch()` function](%nb-ggbunch%)
2019

20+
Demos:
21+
22+
- [Inset map of Kotlin island](%nb-spatialdataset_kotlin_isl%)
23+
2124
## `gggrid`
2225

2326
- [`gggrid`](%api_lets_plot%/gggrid.html) - combines several plots on one figure, organized in a regular grid.
2427

25-
Examples:
28+
Cookbooks:
2629

2730
- [The `gggrid()` function](%nb-plot_grid%)
28-
- [Sharing X,Y-axis scale limits](%nb-gggrid_scale_share%)
31+
- [Sharing X,Y-axis scale limits](%nb-gggrid_scale_share%)
32+
- [Collecting guides in gggrid()](%nb-gggrid_legend_collect%)

Writerside/topics/presentation_options.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
[`guideColorbar()`](%api_scale%/guide-colorbar.html),
1313
[`guides()`](%api_scale%/guides.html)
1414

15-
### Examples
15+
### Cookbooks
1616

1717
- [Themes overview](%nb-themes%)
1818
- [Default theme](%nb-default_theme%)
@@ -34,7 +34,7 @@
3434

3535
[`minimal2`](%api_theme%/theme-minimal2.html),
3636
[`bw`](%api_theme%/theme-b-w.html),
37-
[`grey`](%api_theme%/theme-grey.html),
37+
[`grey`](%api_theme%/theme-grey.html) (or [`gray`](%api_theme%/theme-gray.html)),
3838
[`classic`](%api_theme%/theme-classic.html),
3939
[`light`](%api_theme%/theme-light.html),
4040
[`minimal`](%api_theme%/theme-minimal.html),
@@ -45,7 +45,7 @@
4545
<img alt="All predefined themes" src="complete_themes.png" style="block"/>
4646
</a>
4747

48-
### Predefined Themes Examples
48+
### Predefined Themes Cookbooks
4949

5050
- [Default theme](%nb-default_theme%)
5151
- [Themes overview](%nb-themes%)
@@ -62,13 +62,14 @@
6262
[`solarized light`](%api_theme%/flavor-solarized-light.html),
6363
[`solarized dark`](%api_theme%/flavor-solarized-dark.html),
6464
[`high contrast light`](%api_theme%/flavor-high-contrast-light.html),
65-
[`high contrast dark`](%api_theme%/flavor-high-contrast-dark.html)
65+
[`high contrast dark`](%api_theme%/flavor-high-contrast-dark.html),
66+
[`standard`](%api_theme%/flavor-standard.html)
6667

6768
<a href="%nb-geom_theme_colors%">
6869
<img alt="Theme colors for geometries" src="flavors.png" style="block"/>
6970
</a>
7071

71-
### Flavors Examples
72+
### Flavors Cookbooks
7273

7374
- [Theme flavors](%nb-theme_flavors%)
7475
- [Themes overview](%nb-themes%)

0 commit comments

Comments
 (0)