# @sgratzl/boxplots

> simple boxplot stats helper

Latest version **2.0.0** (published 2024-11-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install @sgratzl/boxplots
pnpm add @sgratzl/boxplots
yarn add @sgratzl/boxplots
bun add @sgratzl/boxplots
```

## Health

**Score 50/100 (C)** — status: stable.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: stale.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2024-11-16 |
| First published | 2020-07-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 82.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Samuel Gratzl |
| Maintainers | sgratzl |
| Keywords | boxplot, whisker, kde, quantiles |

## Links

- npm: https://www.npmjs.com/package/@sgratzl/boxplots
- Repository: https://github.com/sgratzl/boxplots
- Issues: https://github.com/sgratzl/boxplots/issues
- npm.io page: https://npm.io/package/@sgratzl/boxplots

## Recent versions

- 2.0.0 (latest) — 2024-11-16
- 1.3.4 — 2024-11-16
- 1.3.3 — 2024-10-25
- 1.3.2 — 2024-06-08
- 1.3.1 — 2024-06-08
- 1.3.0 — 2021-11-09
- 1.2.2 — 2021-01-06
- 1.2.1 — 2020-07-19
- 1.2.0 — 2020-07-19
- 1.0.0 — 2020-07-14

## README

# BoxPlots

[![License: MIT][mit-image]][mit-url] [![NPM Package][npm-image]][npm-url] [![Github Actions][github-actions-image]][github-actions-url]

A small library for computing boxplot objects with various quantiles options

## Install

```sh
npm install --save @sgratzl/boxplots
```

## Usage

```ts
import boxplot from '@sgratzl/boxplots';

const arr = [
  -0.402253, -1.4521869, 0.135228, -1.8620118, -0.5687531, 0.4218371, -1.1165662, 0.5960255, -0.5008038, -0.394178,
  1.3709885,
];
const b = boxplot(arr);
```

see [Samples](https://github.com/sgratzl/boxplots/tree/master/samples) on Github

or at this [![Open in CodePen][codepen]](https://codepen.io/sgratzl/pen/VweGdvO)

## Development Environment

```sh
npm i -g yarn
yarn set version latest
cat .yarnrc_patch.yml >> .yarnrc.yml
yarn
yarn pnpify --sdk vscode
```

### Common commands

```sh
yarn clean
yarn compile
yarn test
yarn lint
yarn fix
yarn build
yarn docs
yarn release
yarn release:pre
```

[mit-image]: https://img.shields.io/badge/License-MIT-yellow.svg
[mit-url]: https://opensource.org/licenses/MIT
[npm-image]: https://badge.fury.io/js/%40sgratzl%2Fboxplots.svg
[npm-url]: https://npmjs.org/package/@sgratzl/boxplots
[github-actions-image]: https://github.com/sgratzl/boxplots/workflows/ci/badge.svg
[github-actions-url]: https://github.com/sgratzl/boxplots/actions
[codepen]: https://img.shields.io/badge/CodePen-open-blue?logo=codepen
[codesandbox]: https://img.shields.io/badge/CodeSandbox-open-blue?logo=codesandbox

---
_Source: https://npm.io/package/@sgratzl/boxplots · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._