nu_plugin_plotters 0.2.2+0.107.0

A nushell plugin for for plotting charts
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72

<h1 align="center">nu_plugin_plotters</h1>
<p align="center">
  <b>
    A <a href="https://www.nushell.sh">nushell</a> 
    <a href="https://www.nushell.sh/book/plugins.html">plugin</a> for plotting charts.
  </b>
</p>

<br>

<div align="center">

  [![Crates.io Version](https://img.shields.io/crates/v/nu_plugin_plotters?style=for-the-badge)](https://crates.io/crates/nu_plugin_plotters)
  [![Nu Version](https://img.shields.io/badge/dynamic/toml?url=https%3A%2F%2Fraw.githubusercontent.com%2Fcptpiepmatz%2Fnu-jupyter-kernel%2Fmain%2FCargo.toml&query=workspace.dependencies%5B'nu-engine'%5D.version&prefix=v&style=for-the-badge&label=nu%20version&color=%234E9A06)](https://github.com/nushell/nushell)
  [![License](https://img.shields.io/crates/l/nu_plugin_plotters?style=for-the-badge)](https://github.com/cptpiepmatz/nu-jupyter-kernel/blob/main/LICENSE)

</div>

## About
`nu_plugin_plotters` is a plugin for [Nushell](https://www.nushell.sh) that 
provides easy plotting of data using 
[`plotters`](https://github.com/plotters-rs/plotters).

![screenshot](../../media/draw-terminal.png)

## Usage
The plugin provides three main commands:

- **`series`**: 
  Use this command to create a dataset from a list of data points. 
  You can pass in:
  - A table with `x` and `y` columns.
  - A list of 2-element lists representing `x` and `y` coordinates.
  - A plain list of numbers, where the index of each value becomes the `x` value.
  
  You can also apply custom styling to the series.

- **`chart`**: 
  This command creates a chart from one or more series.
  You can either pipe the series into the command or pass them as arguments.
  Charts can also be extended by adding more series, and you have options to
  customize the chart's appearance.

- **`draw`**: 
  This renders the chart onto a canvas.
  You can output to an SVG file (using the `save` command) or display directly
  in the terminal (using iterm, kitty or sixel).

These commands are modular, allowing you to build and inspect charts step by 
step. 
Each command's output is a custom value that can be converted into standard Nu 
values for further inspection or manipulation.

## `nu-jupyter-kernel` Integration
This plugin is integrated directly into the 
[`nu-jupyter-kernel`](https://github.com/cptpiepmatz/nu-jupyter-kernel), so 
there's no need for separate installation to create charts within Jupyter 
notebooks.

Charts are automatically rendered without the need to explicitly call `draw svg`. 
Simply output the chart, and the kernel will handle the `draw svg` command 
behind the scenes. 
If necessary, you can enforce this behavior by using the 
`nuju display svg` command.

## Version Scheme
This crate follows the semantic versioning scheme as required by the
[Rust documentation](https://doc.rust-lang.org/cargo/reference/semver.html).
The version number is represented as `x.y.z+a.b.c`, where `x.y.z` is the version
of the crate and `a.b.c` is the version of the `nu-plugin` that this crate is 
built with.
The `+` symbol is used to separate the two version numbers.