Skip to content

Commit f829995

Browse files
committed
Update docs
1 parent 6ba0b8e commit f829995

File tree

4 files changed

+107
-48
lines changed

4 files changed

+107
-48
lines changed

CHANGELOG.md

Lines changed: 38 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,47 @@
22

33
All notable changes to this project will be documented in this file.
44

5-
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6-
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres
6+
to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [1.2.0] - 2021-01-15
9+
10+
### Added
11+
12+
- Correlation plot builder.
13+
14+
Example: [correlation_plot.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/correlation_plot.ipynb)
15+
16+
- The `gggrid()` plot layout utility
17+
18+
Example: [correlation_plot.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/correlation_plot.ipynb)
19+
20+
- In tooltip customization API:
21+
- options: `center` and `middle` (anchor).
22+
- option 'minWidth'.
23+
24+
Example: [tooltip_config.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/tooltip_config.ipynb)
25+
26+
- The `naText` parameter in `geom_text()`
27+
28+
### Changed
29+
30+
- Built with Lets-Plot v1.5.6 (was v1.5.4).
31+
32+
See Lets-Plot [CHANGELOG.md](https://github.com/JetBrains/lets-plot/blob/master/CHANGELOG.md) for changes and fixes in
33+
1.5.5, 1.5.6.
734

835
## [1.1.0] - 2020-11-20
36+
937
### Added
10-
- GeoTools support (see [geotools.md](https://github.com/JetBrains/lets-plot-kotlin/blob/master/docs/geotools.md)).
11-
- API for tooltip customization (see [tooltips.md](https://github.com/JetBrains/lets-plot-kotlin/blob/master/docs/tooltips.md)).
12-
- `geom_map()`.
13-
- `labelFormat` parameter in `geom_text()`.
14-
- `reverse` parameter in `scale_x/y_discrete()`.
15-
- `scale_x_discrete_reversed()`, `scale_y_discrete_reversed()`
38+
39+
- GeoTools support (see [geotools.md](https://github.com/JetBrains/lets-plot-kotlin/blob/master/docs/geotools.md)).
40+
- API for tooltip customization (
41+
see [tooltips.md](https://github.com/JetBrains/lets-plot-kotlin/blob/master/docs/tooltips.md)).
42+
- `geom_map()`.
43+
- `labelFormat` parameter in `geom_text()`.
44+
- `reverse` parameter in `scale_x/y_discrete()`.
45+
- `scale_x_discrete_reversed()`, `scale_y_discrete_reversed()`
1646

1747
### Changed
1848
- Built with Lets-Plot v1.5.4 (was v1.5.2).

README.md

Lines changed: 40 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -38,14 +38,14 @@
3838
- [Lets-Plot in JVM-based application](#jvm)
3939

4040
- [Lets-Plot Kotlin API](#api)
41-
- [User guide and API reference](#guide)
42-
- [Data sampling](#sampling)
43-
- [GGBunch](#ggbunch)
44-
- [Saving plot to file](#export)
45-
- [Tooltip customization](#tooltip-customization)
46-
- [GeoTools support](#geotools)
47-
48-
- [What is new in 1.1.0](#new)
41+
- [User guide and API reference](#guide)
42+
- [Data sampling](#sampling)
43+
- [GGBunch](#ggbunch)
44+
- [Saving plot to file](#export)
45+
- [Tooltip customization](#tooltip-customization)
46+
- [GeoTools support](#geotools)
47+
48+
- [What is new in 1.2.0](#new)
4949
- [Change log](#change_log)
5050
- [License](#license)
5151

@@ -235,32 +235,50 @@ Learn more: [Tooltip Customization](https://github.com/JetBrains/lets-plot-kotli
235235

236236
[GeoTools](https://www.geotools.org/) is an open source Java GIS Toolkit.
237237

238-
Lets-Plot supports visualization of a set of `SimpleFeature`-s stored in `SimpleFeatureCollection`, as well as
239-
individual `Geometry` and `ReferencedEnvelope` objects.
238+
Lets-Plot supports visualization of a set of `SimpleFeature`-s stored in `SimpleFeatureCollection`, as well as
239+
individual `Geometry` and `ReferencedEnvelope` objects.
240240

241241
Learn more: [GeoTools Support](https://github.com/JetBrains/lets-plot-kotlin/blob/master/docs/geotools.md).
242-
243242

244243
<a id="new"></a>
245-
## What is new in 1.1.0
246244

247-
- Tooltip Customization
245+
## What is new in 1.2.0
246+
247+
- Correlation plot builder.
248+
249+
Usage:
250+
```kotlin
251+
import jetbrains.letsPlot.bistro.corr.CorrPlot
252+
253+
val plot = CorrPlot(data, title = "threshold = 0.5, no diag", threshold = 0.5) // data and optional parameters
254+
.points(type = "upper", diag = true) // Add one or more layers
255+
.build() // Finally, build the plot
256+
```
257+
258+
Example: [correlation_plot.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/correlation_plot.ipynb)
259+
248260

249-
New API for customization of tooltip contents. See [Tooltip Customization](https://github.com/JetBrains/lets-plot-kotlin/blob/master/docs/tooltips.md)) for details.
250-
251-
- Formatting labels in `geom_text()`
261+
- The `gggrid()` plot layout utility
252262

253-
New parameter, 'labelFormat' to define a formatting pattern.
263+
Arranges plots in cells of a regular grid.
254264

255-
See demo: [label_format.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/label_format.ipynb)
256-
257-
- GeoTools support
265+
Example: [correlation_plot.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/correlation_plot.ipynb)
258266

259-
Visualization of GeoTools's `SimpleFeature`-s and other objects. See [GeoTools Support](https://github.com/JetBrains/lets-plot-kotlin/blob/master/docs/geotools.md)) for details.
260267

261-
- Other changes and fixes - see [CHANGELOG.md](https://github.com/JetBrains/lets-plot-kotlin/blob/master/CHANGELOG.md) for details.
268+
- Tooltip Customization API
269+
- new options: `center` and `middle` (anchor).
270+
- new option `minWidth`.
271+
272+
See [Tooltip Customization](https://github.com/JetBrains/lets-plot-kotlin/blob/master/docs/tooltips.md) for details.
273+
274+
Example: [tooltip_config.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/tooltip_config.ipynb)
275+
276+
277+
- Other changes and fixes - see [CHANGELOG.md](https://github.com/JetBrains/lets-plot-kotlin/blob/master/CHANGELOG.md)
278+
for details.
262279

263280
<a id="change_log"></a>
281+
264282
## Change Log
265283

266284
See [CHANGELOG.md](https://github.com/JetBrains/lets-plot-kotlin/blob/master/CHANGELOG.md).

docs/examples.md

Lines changed: 28 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,12 @@ Try the following tutorials and examples to learn and evaluate various features
99
- [Facets](#facets)
1010
- [GGBunch](#ggbunch)
1111
- [`as_discrete()` function](#as_discrete)
12+
- [gggrid()](#gggrig)
1213
- [Export to File](#export)
1314
- [Theme](#theme)
1415
- [Data Sampling](#sampling)
1516
- [Tooltip Customization](#tooltip)
17+
- [Correlation Plot](#corrplot)
1618
- [GeoTools Support](#geotools)
1719

1820
<a id="quickstart"></a>
@@ -75,23 +77,32 @@ Try the following tutorials and examples to learn and evaluate various features
7577
* `facet_grid`:
7678
[distributions.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/distributions.ipynb)
7779

78-
7980
<a id="ggbunch"></a>
81+
8082
#### GGBunch
8183

82-
GGBunch allows to show a collection of plots on one figure. Each plot in the collection can have arbitrary location and size. There is no automatic layout inside the bunch.
84+
GGBunch allows to show a collection of plots on one figure. Each plot in the collection can have arbitrary location and
85+
size. There is no automatic layout inside the bunch.
86+
87+
* [ggbunch.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/ggbunch.ipynb)
88+
* [geom_smooth.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/geom_smooth.ipynb)
89+
90+
<a id="gggrid"></a>
91+
92+
#### gggrid()
8393

84-
* [ggbunch.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/ggbunch.ipynb)
85-
* [geom_smooth.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/geom_smooth.ipynb)
94+
A simple utility which you can use to arrange plots in a regular grid.
8695

96+
* [correlation_plot.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/correlation_plot.ipynb)
8797

8898
<a id="as_discrete"></a>
89-
#### `as_discrete()` function
9099

91-
* [geom_smooth.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/geom_smooth.ipynb)
100+
#### `as_discrete()` function
92101

102+
* [geom_smooth.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/geom_smooth.ipynb)
93103

94104
<a id="export"></a>
105+
95106
#### Export to File
96107

97108
The `ggsave()` function is an easy way to export plot to a file in SVG, HTML or raster formats.
@@ -113,16 +124,25 @@ Sampling is a special technique of data transformation, which helps dealing with
113124

114125
See: [Sampling in Lets-Plot](https://github.com/JetBrains/lets-plot-kotlin/blob/master/docs/sampling.md).
115126

116-
* Pick sampling on Bar-chart: [sampling_pick.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/sampling_pick.ipynb)
117-
* Stratified sampling: [sampling_stratified.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/sampling_stratified.ipynb)
127+
* Pick sampling on
128+
Bar-chart: [sampling_pick.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/sampling_pick.ipynb)
129+
* Stratified
130+
sampling: [sampling_stratified.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/sampling_stratified.ipynb)
118131

119132
<a id="tooltip"></a>
133+
120134
#### Tooltip Customization
121135

122136
* [tooltip_config.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/tooltip_config.ipynb)
123137

138+
<a id="corrplot"></a>
139+
140+
#### Correlation Plot
141+
142+
* [correlation_plot.ipynb](https://nbviewer.jupyter.org/github/JetBrains/lets-plot-kotlin/blob/master/docs/examples/jupyter-notebooks/correlation_plot.ipynb)
124143

125144
<a id="geotools"></a>
145+
126146
#### GeoTools Support
127147

128148
See [GeoTools Support](https://github.com/JetBrains/lets-plot-kotlin/blob/master/docs/geotools.md).

future_changes.md

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,3 @@
1-
## [1.1.1] - 2021-xx-xx
1+
## [1.2.1] - 2021-xx-xx
22

33
### Added
4-
5-
- In tooltip customization API:
6-
- options: `center` and `middle` (anchor).
7-
- option 'minWidth'.
8-
9-
See: [Tooltip Customization](https://github.com/JetBrains/lets-plot-kotlin/blob/master/docs/tooltips.md).
10-
11-
- `gggrid()` - arranges plots in cells of a regular grid.
12-
- `naText` parameter in 'geom_text'

0 commit comments

Comments
 (0)