⚓️ Install

Fri, 27 Mar 2026 00:00:00 +0000

🍺 Homebrew
#

$ brew tap tamada/brew
$ brew install heatman

💪 Build from source codes
#

git clone https://github.com/tamada/heatman.git
cd heatman
cargo build --release

🏃 Usage

Fri, 27 Mar 2026 00:00:00 +0000

This is the CLI interface of heatman. The CLI interface is implemented in the heatman crate, which is a binary crate. The main function of the CLI interface is to parse the command line arguments and call the appropriate functions in the heatman library crate.

🏃 Usage
#

$ 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.

ℹ️ About

Fri, 27 Mar 2026 00:00:00 +0000

🧑‍💼 Authors 👩‍💼
#

Haruaki Tamada

📜 License
#

This project is licensed under the MIT License. See the LICENSE file for details.

:house: Home on Heatman

⚓️ Install

🍺 Homebrew
#

💪 Build from source codes
#

🏃 Usage

🏃 Usage
#

🚶 The results of examples
#

ℹ️ About

🧑‍💼 Authors 👩‍💼
#

📜 License
#

🎃 Logo
#

:house: Home on Heatman

⚓️ Install

🍺 Homebrew #

💪 Build from source codes #

🏃 Usage

🏃 Usage #

🚶 The results of examples #

ℹ️ About

🧑‍💼 Authors 👩‍💼 #

📜 License #

🎃 Logo #

🍺 Homebrew
#

💪 Build from source codes
#

🏃 Usage
#

🚶 The results of examples
#

🧑‍💼 Authors 👩‍💼
#

📜 License
#

🎃 Logo
#