Terminal Visualizer
Ruby program to read a series of datasets from a csv-formatted file and visualize the data as terminal output. The first line of data will be drawn as the bottom line in the visualized output.
You can choose between the following output:
- Visualization of a dataset from a series of data
- Visualization of the value differences of two datasets
- Visualization of a timeline from a point within the data domain
- Animation of all datasets
- Interpolation of a value of a dataset within the data domain
Current version: v0.9.2
Usage & Help
``` script usage: ruby
TerminalVis help:
-h, –help show help text
-v, –version prints the current version of the project
-f, –file argument:
Invalid parameter combinations: -a + -d, -a + -i, -a + -t -r + -t, -r + -i -c + -e, -c + -t -d + -i, -d + -t
Available configuration parameter: Timeline: number of interval steps in y-dimension [5,100] Color legend: extended informations about the intervals Scaling: automatic scaling of the output to the size of the calling terminal (atm standard dataset output, e.g. -i only) ```
Invalid parameter combinations
-a + -d, -a + -i, -a + -t
-r + -t, -r + -i
-c + -e, -c + -t
-d + -i, -d + -t
Configuration options
Configuration parameter
Configuration paramters can be specified by the parameter -o. From their they can inserted manually or from a file. The current parameters are:
- Timeline y-dimension: specifies how much interval steps in y-dimension should be used; value interval [5, 100]
- Extended color legend information: specifies if the interval values should be displayed
- Output scaling: scales the visualized output to fit in the terminal, that started the script
Default values
- Timeline y-dimension: 20
- Extended color legend information: off
- Output scaling: off
Examples
Reading a data series from <filename>
with meta data and visualizing the first
dataset:
ruby terminal_vis.rb -m <filename>
Reading a data series from <filename>
without meta data and visualizing the
dataset at <index>
:
ruby terminal_vis.rb -i <index> <filename>
Reading a data series from <filename>
with meta data and creating a timeline
for the coordinate (<x>,<y>)
:
ruby terminal_vis.rb -m -t <x> <y> <filename>
Reading a data series from <filename>
with meta data and animating a specific
interval from the data series:
ruby terminal_vis.rb -m -r <start> <end> -a <speed> <filename>
Running the script to visualize a dataset from <filename>
and entering
configuration option through the menu:
ruby terminal_vis.rb -m -i <index> -o menu <filename>
Running the script to visualize a specific region of a dataset from
<filename>
:
ruby terminal_vis.rb -m -i <index> -c <x> <y> -s <interval> <delta> <filename>
Documentation
Documentation is written in yard and can be created by running the shell-script
create_yard.sh
. Yard needs to be installed on the system in order to do that.
The documentation can also be found online here.
Meta data format (in single line):
#### Two dimensional data set: ```