heatman 0.1.0

Creating heatmap image from given CSV file
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

# Heatman

[![build](https://github.com/tamada/heatman/actions/workflows/build.yaml/badge.svg)](https://github.com/tamada/heatman/actions/workflows/build.yaml)
[![Coverage Status](https://coveralls.io/repos/github/tamada/heatman/badge.svg?branch=main)](https://coveralls.io/github/tamada/heatman?branch=main)

[![Version](https://img.shields.io/badge/Version-v0.1.0-green)](https://github.com/tamada/heatman/releases/tag/v0.1.0)
[![License](https://img.shields.io/badge/License-MIT-green)](https://github.com/tamada/heatman/blob/main/LICENSE)

[![Docker](https://img.shields.io/badge/Docker-ghcr.io/tamada/heatman:0.1.0-blue?logo=docker)](https://github.com/tamada/heatman/pkgs/container/heatman/)
[![Homebrew](https://img.shields.io/badge/Homebrew-tamada/tap/heatman-blue?logo=homebrew)](https://github.com/tamada/homebrew-tap)

Heatmap generator for visualizing data in a matrix format.

## 🏃 Usage

```sh
$ heatman testdata/sample.csv
# generate heatman.png
$ heatman --help
Heatmap generator for visualizing data in a matrix format.

Usage: heatman [OPTIONS] [INPUT_FILE]

Arguments:
  [INPUT_FILE]  Input files containing the data to be plotted. The csv file should contain the row and column header.

Options:
  -d, --dest <DEST>
          Destination path for the output image [default: heatman.png]
  -a, --assistant-line-gap <ASSISTANT_LINE_GAP>
          Assistant line gap in cells. If 0, no assistant line will be drawn. [default: 0]
  -p, --pixel <PIXEL>
          Pixel size of cells [default: 3]
  -m, --mode <MODE>
          Output mode [default: heatmap] [possible values: scaler, heatmap, rows, columns]
  -l, --level <LEVEL>
          Logging level (trace, debug, info, warn, error) [default: warn] [possible values: trace, debug, info, warn, error]
  -r, --range <RANGE>
          Specify the value range for the input data. [default: 0-1]
      --order <ORDER>
          The file describing the order of the data to be plotted.
          Each line should contain a single string that matches the name of the data to be plotted.
          The triple dash line (---) means the assistant line is drawn here.
          The # is the comment line. escape the # with \# if you want to use it as a name.
          If not provided, the order will be determined by the order of the data in the input files.
      --row-order <ROW_ORDER>
          The file describing the order of the rows to be plotted.
      --column-order <COLUMN_ORDER>
          The file describing the order of the columns to be plotted.
  -h, --help
          Print help (see more with '--help')
  -V, --version
          Print version
$ heatman -p 15 -d heatman_with_assistant_line.png -a 4 testdata/sample.csv
# generate heatman_with_assistant_line.png with assistant lines gapped between 4 cells.
$ heatman --mode scaler -d scaler.png
# generate scaler.png, which shows the scaler of colors.
```

### 🚶 The results of examples

Each image is generated by above command.

#### 🌃 `heatman.png`

![heatman.png](https://github.com/tamada/heatman/raw/main/assets/images/heatman.png)

It was too small.
The one cell in csv is shown in one pixel.

#### 🎑 `heatman_with_assistant_line.png`

The one cell in csv is shown in 15-pixel.

![heatman_with_assistant_line.png](https://github.com/tamada/heatman/raw/main/assets/images/heatman_with_assistant_line.png)

#### 🌄 `heatman_scaler.png`

This is generated scaler image.
The left side shows 0.0, and the right side shows 1.0.

![scaler.png](https://github.com/tamada/heatman/raw/main/assets/images/scaler.png)