cyrilou242 / lets-plot-kotlin

Kotlin API for Lets-Plot Multiplatform plotting library based on the Grammar of Graphics

Home Page:https://lets-plot.org/kotlin/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Lets-Plot Kotlin API

official JetBrains project License MIT Latest Release

Lets-Plot Kotlin API is a Kotlin API for Lets-Plot Multiplatform plotting library,
which is built on the principles of layered graphics first described in the
Leland Wilkinson work The Grammar of Graphics.

book cover

Lets-Plot Kotlin API is largely based on the API
provided by ggplot2 package well-known to data scientists who use R.

To learn more about the Grammar of Graphics,
we recommend an excellent book called
“ggplot2: Elegant Graphics for Data Analysis”.

This will be a good prerequisite for further exploration of the Lets-Plot library.

Quickstart

Inside Kotlin Notebook, Datalore or Jupyter with Kotlin Kernel:

%use lets-plot
val rand = java.util.Random()
val data = mapOf(
    "rating" to List(200) { rand.nextGaussian() } + List(200) { rand.nextGaussian() * 1.5 + 1.5 },
    "cond" to List(200) { "A" } + List(200) { "B" }
)

var p = letsPlot(data)
p += geomDensity(color = "dark_green", alpha = .3) { x = "rating"; fill = "cond" }
p + ggsize(700, 350)

Couldn't load quickstart_notebook.png


See the "Quickstart" notebook in Datalore or Jupyter nbviewer.

Table of Contents

Usage

Notebooks

With the help of Lets-Plot Kotlin API you can easily create plots in Kotlin Notebook, Datalore, Jupyter with Kotlin Kernel
or any other notebook that supports Kotlin Kernel.

"Line Magics"

%use lets-plot

This "line magic" will apply Lets-Plot library descriptor which adds to your notebook all the boilerplate code necessary to create plots.

By default, library descriptor is bundled with the Kotlin Jupyter Kernel installed in your environment.
However, you can override the default settings using:

%useLatestDescriptors

In this case the latest library descriptor will be pulled from the Kotlin Jupyter Libraries repository.

Library Descriptor Parameters

%use lets-plot(api=4.4.3, lib=4.0.1, js=4.0.1, isolatedFrame=false)
  • api - version of the Lets-Plot Kotlin API.
  • lib - version of the Lets-Plot Multiplatform (JARs).
  • js - version of the Lets-PLot Multiplatform JavaScript bundle.
  • isolatedFrame - If false: load JS just once per notebook (default in Jupyter). If true: include Lets-Plot JS in each output (default in Datalore notebooks).

Compose Multiplatform

To learn how to embed Lets-Plot charts in Compose Multiplatform applications, please check out the Lets-Plot Skia Frontend project.

JVM and Kotlin/JS

To learn more about creating plots in JVM or Kotlin/JS environment please read USAGE_SWING_JFX_JS.md.

Examples

Examples of using of the Lets-Plot Kotlin API in JVM and Kotlin/JS applications are available in the Lets-Plot Kotlin Mini Apps (Demos) GitHub repository.

Documentation

What is new in 4.4.2

Note: Due to major package refactoring in the main Lets-Plot library, this version (4.4.2) of the Kotlin API
is not compatible with versions of Lets-Plot library v3.2.0 and earlier.

A Number of Geometry Defaults Changed

  • The default qualitative color palette is now Color Brewer "Set1" (was "Set2").
  • Slightly bigger default size of points and width of lines.
  • Flavor-aware default colors for points, lines etc.
    f-23c/images/geom_defaults.png
    f-23c/images/flavor_geom_colors.png

See: example notebook.

  • Size of points is slightly adjusted to match the width of a line of the same "size".
    f-23c/images/point_vs_line.png

Support for Variadic Line Width and/or Color in geomLine() and geomPath()


f-23c/images/variadic_width.png

See: example notebook.

Parameter "sizeUnit" in geomPie()

A way to specify size of the pie in units relative to the plot size.

See: example notebook.

Stroke and Spacers in geomPie()


f-23c/images/pie_stroke.png

See: example notebook.

New themeVoid(), Geometries and Statistics

Other improvements and fixes

See CHANGELOG.md for details.

Migrating from v3 to v4

For migration instructions see Migrating to 4.0.0 section in the CHANGELOG.

Change Log

See CHANGELOG.md.

Code of Conduct

This project and the corresponding community are governed by the JetBrains Open Source and Community Code of Conduct. Please make sure you read it.

License

Code and documentation released under the MIT license. Copyright © 2019-2023, JetBrains s.r.o.

About

Kotlin API for Lets-Plot Multiplatform plotting library based on the Grammar of Graphics

https://lets-plot.org/kotlin/

License:MIT License


Languages

Language:Kotlin 98.4%Language:HTML 1.6%Language:Shell 0.0%