YouPlot/README.md
2020-12-12 21:52:02 +09:00

103 lines
1.9 KiB
Markdown

# YouPlot
![Build Status](https://github.com/kojix2/youplot/workflows/test/badge.svg)
[![Gem Version](https://badge.fury.io/rb/youplot.svg)](https://badge.fury.io/rb/youplot)
[![Docs Latest](https://img.shields.io/badge/docs-latest-blue.svg)](https://rubydoc.info/gems/youplot)
[![The MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE.txt)
Create ASCII charts on the terminal with data from standard streams in the pipeline.
:bar_chart: Powered by [UnicodePlot](https://github.com/red-data-tools/unicode_plot.rb)
## Installation
```
gem install youplot
```
## Screenshots
### barplot
```sh
```
### histogram
```sh
curl -s https://raw.githubusercontent.com/kojix2/youplot/main/test/fixtures/iris.csv \
| cut -f1-4 -d, \
| uplot scatter -H -d, -t IRIS
```
### lineplot
```sh
curl -s https://www.mhlw.go.jp/content/pcr_positive_daily.csv \
| cut -f2 -d, \
| uplot line -w 50 -h 15 -t 'PCR positive tests' --xlabel Date --ylabel number
```
### scatter
```sh
curl -s https://git.io/JIiqE \
| cut -f1-4 \
| uplot scatter -H -t IRIS
```
### density
```sh
curl -s https://raw.githubusercontent.com/kojix2/youplot/main/test/fixtures/iris.csv \
| cut -f1-4 \
| uplot density -H -t IRIS
```
### boxplot
```sh
curl -s https://raw.githubusercontent.com/kojix2/youplot/main/test/fixtures/iris.csv \
| cut -f1-4 \
| uplot boxplot -H -t IRIS
```
### colors
```sh
uplot colors
```
## Usage
`uplot --help`
Use `--help` to print command-specific options.
`uplot hist --help`
```
Usage: uplot histogram [options] <in.tsv>
Options for histogram:
--symbol VAL character to be used to plot the bars
--closed VAL
-n, --nbins VAL approximate number of bins
Options:
...
```
## Development
Let's keep it simple.
## Contributing
Bug reports and pull requests are welcome on GitHub at [https://github.com/kojix2/youplot](https://github.com/kojix2/youplot).
## License
[MIT License](https://opensource.org/licenses/MIT).