chart-relative 0.1.2

Compact bar charts in the terminal.
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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88

# chart-relative
A library and CLI tool for generating compact text-based charts.

[![Crates.io](https://img.shields.io/crates/v/chart-relative.svg)](https://crates.io/crates/chart-relative)
[![Docs.rs](https://docs.rs/chart-relative/badge.svg)](https://docs.rs/chart-relative)
[![CI](https://github.com/guapodero/chart-relative/workflows/CI/badge.svg)](https://github.com/guapodero/chart-relative/actions)

## Why
I needed a simple way to visualize a small distribution of word counts and the effect of applying a filter.

## Goals
* Text output
* Indicate outliers
* Maximize information density

## CLI
```txt
USAGE:
  chart-relative  [--max-height u16] [( --view-bottom | --view-top )]

  [--max-height u16]               Maximum number of lines to use for display before scaling. default: 16
  [( --view-bottom | --view-top )] Which end of range to show, if too large to show all. default: bottom


Standard Input:

    The standard input stream should contain 1-3 columns, separated by spaces.
    Input is truncated after 100 lines.

    Either:

    1. Only data
    integer

    2. Labeled data
    integer string

    3. Unlabeled comparison data
    integer integer

    4. Labeled comparison data
    integer integer string
```

## Examples

```echo "4 104 889 5517 22861 73805 184473 369441 599945 800265 881140 801904 600813 370368 185082 73635 23325 5399 931 95 4" | tr ' ' '\n' | chart-relative --view-top```

![bell.png](bell.png)

```printf '%s\n' "4 1978" "104 3256" "889 5354" "5517 8789" "22861 14388" "73805 23449" "184473 37940" "369441 60686" "599945 95362" "800265 145940" "881140 215153" "801904 302032" "600813 400000" "370368 497967" "185082 584846" "73635 654059" "23325 704637" "5399 739313" "931 762059" "95 776550" "4 785611" | chart-relative --view-top```

![bell_logistic.png](bell_logistic.png)

More examples are available by running the tests.
`cargo test -- --nocapture`

## Related Work
[lowcharts](https://crates.io/crates/lowcharts) can also be used to generate bar charts, and
is more suitable for general purpose use. In contrast, chart-relative is useful for comparing
two related data sets which may contain outliers.

## Installation

### Cargo

* Install the rust toolchain in order to have cargo installed by following
  [this](https://www.rust-lang.org/tools/install) guide.
* run `cargo install chart-relative`

## License

Licensed under either of

 * Apache License, Version 2.0
   ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
 * MIT license
   ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)

at your option.

## Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.

See [CONTRIBUTING.md](CONTRIBUTING.md).