73 Commits

Author SHA1 Message Date
kojix2
58ba6bb966 v0.2.8 2020-11-15 00:46:45 +09:00
kojix2
b4585b053a Fix comment 2020-11-15 00:43:13 +09:00
kojix2
19c3b0367a Rubocop auto correct 2020-11-15 00:43:00 +09:00
kojix2
159b90998b Improved main help menu 2020-11-15 00:29:20 +09:00
kojix2
a6ff1ebf2e show the help option on usage 2020-11-14 23:41:35 +09:00
kojix2
f8ea11f0d0 Improved help messages 2020-11-14 23:09:49 +09:00
kojix2
406fb80377 Improved README 2020-11-14 22:22:37 +09:00
kojix2
4d761dd0e7 Show barplot with line num as labels if 1 series 2020-11-13 11:22:36 +09:00
kojix2
471f0a907e Removed raw_inputs 2020-11-10 23:09:41 +09:00
kojix2
552756cadf Fix test 2020-11-08 12:22:47 +09:00
kojix2
4b4848438c Make sure the labels are String 2020-11-08 12:21:05 +09:00
kojix2
6f9c77f4fe Rename count -> count_values 2020-11-08 01:41:13 +09:00
kojix2
40304329bc Update README.md 2020-11-06 10:37:29 +09:00
kojix2
2ecaa278c2 Update README
* How to show sub-coomand help
2020-11-06 10:29:17 +09:00
kojix2
3ab02e5a05 Update README.md 2020-11-06 10:23:44 +09:00
kojix2
2181e4a0f7 Fix color command option 2020-11-06 10:21:36 +09:00
kojix2
7fc7c797af Removed file name extensions 2020-11-06 10:00:55 +09:00
kojix2
942705ab23 Update help messages 2020-11-06 09:56:35 +09:00
kojix2
f7a7dcd1d4 Added that the command takes a file as an argument 2020-11-05 10:41:38 +09:00
kojix2
d085828883 Update README.md
* Added -e option to make the echo command work on both Mac and Ubuntu. (#1)
2020-11-04 16:08:34 +09:00
284km
93f8efc60a Output \n as a string in example code
Current output is:

$ echo "from numpy import random;" \
>      "n = random.randn(10000);"  \
>      "print('\n'.join(str(i) for i in n))"
from numpy import random; n = random.randn(10000); print('
'.join(str(i) for i in n))

After this change, I think it is originally expected string:

$ echo "from numpy import random;" \
>      "n = random.randn(10000);"  \
>      "print('\\\n'.join(str(i) for i in n))"
from numpy import random; n = random.randn(10000); print('\n'.join(str(i) for i in n))
2020-11-04 15:49:22 +09:00
kojix2
99e9e28ec9 Update README.md 2020-11-04 15:37:19 +09:00
kojix2
54e1865640 Update README.md 2020-10-13 18:40:56 +09:00
kojix2
00c2ce9b44 v0.2.7 2020-10-12 23:08:32 +09:00
kojix2
84196c197d Revert "Show message when No input data provided"
Uplot should expect cases where data takes a long time to reach the standard input.
This mechanism is not appropriate.

This reverts commit c40c59a21d.
2020-10-12 20:44:31 +09:00
kojix2
c40c59a21d Show message when No input data provided
Thank you csvkit developers
2020-10-12 17:10:25 +09:00
kojix2
c4f21df588 Show subcommand options ahead 2020-10-12 16:45:28 +09:00
kojix2
39166894a3 Improved help banner
Summary width 24
2020-10-12 16:14:51 +09:00
kojix2
7b8213833f Removed 'under development' in README 2020-10-12 14:57:03 +09:00
kojix2
9090bbf51b Fix help banner 2020-10-12 14:52:56 +09:00
kojix2
428d525c5f Add sample codes to README 2020-10-12 14:24:02 +09:00
kojix2
6ebc707c51 Add images to README.md 2020-10-12 14:04:36 +09:00
kojix2
c73da80de6 v0.2.6 2020-10-12 07:45:42 +09:00
kojix2
2e8641ccea Improved descs 2020-10-11 09:23:57 +09:00
kojix2
1b43f7d48f Add comment about pass 2020-10-11 08:29:02 +09:00
kojix2
d8396fecf9 Rubocop auto correct 2020-10-11 08:28:39 +09:00
kojix2
4660c2ab02 Extract case-branching by fmt into another method 2020-10-11 08:02:43 +09:00
kojix2
d7e49f048f Add a comment to params 2020-10-11 07:55:20 +09:00
kojix2
34ae2b5815 v0.2.5 2020-10-11 00:14:18 +09:00
kojix2
7e8dc6190c Fix arg order 2020-10-11 00:11:54 +09:00
kojix2
ba105ab1f3 Improved help desc 2020-10-10 23:58:53 +09:00
kojix2
96a1d1feb9 Fix style 2020-10-10 23:58:53 +09:00
kojix2
2b65dae60c Add a image to README.md 2020-10-10 23:35:26 +09:00
kojix2
943d4e6c44 Use keyword arg for count 2020-10-10 23:21:55 +09:00
kojix2
de33805c56 Drop support for ruby 2.3 2020-10-10 23:18:27 +09:00
kojix2
de3a366d15 Fix debug option 2020-10-10 23:16:15 +09:00
kojix2
4544c0e456 Removed count option for barplot 2020-10-10 23:08:20 +09:00
kojix2
ccfbaa7bde Allows you to specify the output file 2020-09-29 18:16:42 +09:00
kojix2
3aceae9279 Improved command description 2020-09-29 18:14:41 +09:00
kojix2
731daef3f8 v0.2.4 2020-09-25 00:55:00 +09:00
kojix2
78363cd198 Update banner 2020-09-25 00:52:33 +09:00
kojix2
0389f7fc5c create sub-parsers using case instead of Hash 2020-09-23 21:32:11 +09:00
kojix2
a33b0e7628 Rubocop auto correct 2020-09-19 00:08:09 +09:00
kojix2
4d62acea75 Remove get_lim
* Use only comma separators
* A hyphen is indistinguishable from a minus sign
* Colon separators aren't as common as commas
2020-09-19 00:06:03 +09:00
kojix2
e22976c1a2 Fix loading file order 2020-09-17 16:51:58 +09:00
kojix2
385d02d232 Fix color check 2020-09-17 10:45:57 +09:00
kojix2
0ce394a11d Fix style 2020-09-17 10:45:44 +09:00
kojix2
3baada320e Fix variables again 2020-09-17 10:38:59 +09:00
kojix2
b6c3ca9b43 Fix variables 2020-09-17 10:28:01 +09:00
kojix2
975eb95f55 Add parser class 2020-09-17 10:06:31 +09:00
kojix2
bd16c30613 Avoid multi-line chains of blocks... 2020-09-17 09:33:31 +09:00
kojix2
3a8c1e62f3 Fixed command descriptions 2020-09-17 00:24:08 +09:00
kojix2
522a111aa9 Improved help message of sub parsers 2020-09-16 23:50:24 +09:00
kojix2
7020785818 Added description of command line options 2020-09-16 23:14:20 +09:00
kojix2
c25d47d721 v0.2.3 2020-09-15 20:00:28 +09:00
kojix2
40c5d9fbdf Add create_main_parser method 2020-09-15 19:57:37 +09:00
kojix2
3e3b1cdfec Fix typo 2020-09-15 19:15:55 +09:00
kojix2
661e5048dd Rubocop auto correct 2020-09-15 18:58:34 +09:00
kojix2
3b8846efbe Add new file params.rb 2020-09-15 18:58:25 +09:00
kojix2
50cb8d7463 Add create_sub_parser method 2020-09-15 18:51:32 +09:00
kojix2
b1df2ed544 Rename create_parser -> create_default_parser 2020-09-15 18:42:38 +09:00
kojix2
05c3b14acd Add color command 2020-08-24 20:17:33 +09:00
kojix2
9e2f169e6c Rename plot_type -> command 2020-08-24 20:17:12 +09:00
17 changed files with 550 additions and 325 deletions

View File

@@ -1,3 +1,5 @@
# frozen_string_literal: true
source 'https://rubygems.org'
# Specify your gem's dependencies in uplot.gemspec

137
README.md
View File

@@ -9,15 +9,15 @@ Create ASCII charts on the terminal with data from standard streams in the pipel
:bar_chart: Powered by [UnicodePlot](https://github.com/red-data-tools/unicode_plot.rb)
:construction: Under development! :construction:
## Installation
```
gem install u-plot
```
## Usage
Note: The name of the Gem is `u-plot` (not uplot).
## Screenshots
**histogram**
@@ -26,42 +26,125 @@ ruby -r numo/narray -e "puts Numo::DFloat.new(1000).rand_norm.to_a" \
| uplot hist --nbins 15
```
<img src="https://i.imgur.com/wpsoGJq.png" width="75%" height="75%">
```sh
echo -e "from numpy import random;" \
"n = random.randn(10000);" \
"print('\\\n'.join(str(i) for i in n))" \
| python \
| uplot hist --nbins 20
```
┌ ┐
[-4.5, -4.0) ┤ 1
[-4.0, -3.5) ┤ 0
[-3.5, -3.0) ┤ 1
[-3.0, -2.5) ┤▇▇ 9
[-2.5, -2.0) ┤▇▇▇ 15
[-2.0, -1.5) ┤▇▇▇▇▇▇▇▇▇ 50
[-1.5, -1.0) ┤▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇ 97
[-1.0, -0.5) ┤▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇ 154
[-0.5, 0.0) ┤▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇ 193
[ 0.0, 0.5) ┤▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇ 165
[ 0.5, 1.0) ┤▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇ 152
[ 1.0, 1.5) ┤▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇ 86
[ 1.5, 2.0) ┤▇▇▇▇▇▇▇▇▇ 51
[ 2.0, 2.5) ┤▇▇▇▇ 21
[ 2.5, 3.0) ┤▇ 3
[ 3.0, 3.5) ┤ 2
└ ┘
Frequency
```
<img src="https://i.imgur.com/97R2MQx.png" width="75%" height="75%">
**scatter**
```sh
wget https://raw.githubusercontent.com/uiuc-cse/data-fa14/gh-pages/data/iris.csv -qO - \
| cut -f1-4 -d, \
| uplot scatter -H -d, -t IRIS -m 10
curl -s https://raw.githubusercontent.com/uiuc-cse/data-fa14/gh-pages/data/iris.csv \
| cut -f1-4 -d, \
| uplot scatter -H -d, -t IRIS
```
<img src="https://i.imgur.com/STX7bFT.png" width="75%" height="75%">
**line**
```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
```
<img src="https://i.imgur.com/PVl5dsa.png" width="75%" height="75%">
**box**
```sh
curl -s https://raw.githubusercontent.com/uiuc-cse/data-fa14/gh-pages/data/iris.csv \
| cut -f1-4 -d, \
| uplot box -H -d, -t IRIS
```
<img src="https://i.imgur.com/sNI4SmN.png" width="75%" height="75%">
**colors**
```sh
uplot colors
```
<img src="https://i.imgur.com/LxyHQsz.png">
## Usage
`uplot --help`
```
Program: uplot (Tools for plotting on the terminal)
Version: 0.2.7 (using UnicodePlot 0.0.4)
Source: https://github.com/kojix2/uplot
Usage: uplot <command> [options] <in.tsv>
Commands:
barplot bar
histogram hist
lineplot line
lineplots lines
scatter s
density d
boxplot box
colors show the list of available colors
count c baplot based on the number of occurrences
(slower than `sort | uniq -c | sort -n -k1`)
Options:
-O, --pass [VAL] file to output standard input data to [stdout]
for inserting uplot in the middle of Unix pipes
-o, --output VAL file to output results to [stderr]
-d, --delimiter VAL use DELIM instead of TAB for field delimiter
-H, --headers specify that the input has header row
-T, --transpose transpose the axes of the input data
-t, --title VAL print string on the top of plot
-x, --xlabel VAL print string on the bottom of the plot
-y, --ylabel VAL print string on the far left of the plot
-w, --width VAL number of characters per row
-h, --height VAL number of rows
-b, --border VAL specify the style of the bounding box
-m, --margin VAL number of spaces to the left of the plot
-p, --padding VAL space of the left and right of the plot
-c, --color VAL color of the drawing
--[no-]labels hide the labels
--fmt VAL xyxy : header is like x1, y1, x2, y2, x3, y3...
xyy : header is like x, y1, y2, y2, y3...
```
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/uplot](https://github.com/kojix2/uplot).
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
[MIT License](https://opensource.org/licenses/MIT).

View File

@@ -1,3 +1,5 @@
# frozen_string_literal: true
require 'bundler/gem_tasks'
require 'rake/testtask'

View File

@@ -1,4 +1,5 @@
#!/usr/bin/env ruby
# frozen_string_literal: true
require 'uplot'

View File

@@ -1,3 +1,5 @@
# frozen_string_literal: true
require 'unicode_plot'
require 'uplot/version'
require 'uplot/preprocessing'

View File

@@ -1,275 +1,78 @@
require 'optparse'
# frozen_string_literal: true
require_relative 'preprocessing'
require_relative 'command/parser'
module Uplot
Data = Struct.new(:headers, :series)
class Command
Params = Struct.new(
# Sort me!
:title,
:width,
:height,
:border,
:margin,
:padding,
:color,
:xlabel,
:ylabel,
:labels,
:symbol,
:xscale,
:nbins,
:closed,
:canvas,
:xlim,
:ylim,
:grid,
:name
) do
def to_hc
to_h.compact
end
end
attr_accessor :params, :plot_type
attr_reader :raw_inputs, :data, :fmt
attr_accessor :params
attr_reader :data, :fmt, :parser
def initialize
@params = Params.new
@plot_type = nil
@headers = nil
@delimiter = "\t"
@transpose = false
@output = false
@count = false
@fmt = 'xyy'
@raw_inputs = []
@debug = false
end
def create_parser
OptionParser.new do |opt|
opt.program_name = 'uplot'
opt.version = Uplot::VERSION
opt.on('-o', '--output', TrueClass) do |v|
@output = v
end
.on('-d', '--delimiter VAL', String) do |v|
@delimiter = v
end
.on('-H', '--headers', TrueClass) do |v|
@headers = v
end
.on('-T', '--transpose', TrueClass) do |v|
@transpose = v
end
.on('-t', '--title VAL', String) do |v|
params.title = v
end
.on('-w', '--width VAL', Numeric) do |v|
params.width = v
end
.on('-h', '--height VAL', Numeric) do |v|
params.height = v
end
.on('-b', '--border VAL', Numeric) do |v|
params.border = v
end
.on('-m', '--margin VAL', Numeric) do |v|
params.margin = v
end
.on('-p', '--padding VAL', Numeric) do |v|
params.padding = v
end
.on('-c', '--color VAL', String) do |v|
params.color = v =~ /\A[0-9]+\z/ ? v.to_i : v.to_sym
end
.on('-x', '--xlabel VAL', String) do |v|
params.xlabel = v
end
.on('-y', '--ylabel VAL', String) do |v|
params.ylabel = v
end
.on('-l', '--labels', TrueClass) do |v|
params.labels = v
end
.on('--fmt VAL', String) do |v|
@fmt = v
end
.on('--debug', TrueClass) do |v|
@debug = v
end
end
end
def parse_options(argv = ARGV)
main_parser = create_parser
parsers = Hash.new { |h, k| h[k] = create_parser }
parsers[:barplot] = \
parsers[:bar]
.on('--symbol VAL', String) do |v|
params.symbol = v
end
.on('--xscale VAL', String) do |v|
params.xscale = v
end
.on('--count', TrueClass) do |v|
@count = v
end
parsers[:count] = \
parsers[:c] # barplot -c
.on('--symbol VAL', String) do |v|
params.symbol = v
end
parsers[:histogram] = \
parsers[:hist]
.on('-n', '--nbins VAL', Numeric) do |v|
params.nbins = v
end
.on('--closed VAL', String) do |v|
params.closed = v
end
.on('--symbol VAL', String) do |v|
params.symbol = v
end
parsers[:lineplot] = \
parsers[:line]
.on('--canvas VAL', String) do |v|
params.canvas = v
end
.on('--xlim VAL', String) do |v|
params.xlim = get_lim(v)
end
.on('--ylim VAL', String) do |v|
params.ylim = get_lim(v)
end
parsers[:lineplots] = \
parsers[:lines]
.on('--canvas VAL', String) do |v|
params.canvas = v
end
.on('--xlim VAL', String) do |v|
params.xlim = get_lim(v)
end
.on('--ylim VAL', String) do |v|
params.ylim = get_lim(v)
end
parsers[:scatter] = \
parsers[:s]
.on('--canvas VAL', String) do |v|
params.canvas = v
end
.on('--xlim VAL', String) do |v|
params.xlim = get_lim(v)
end
.on('--ylim VAL', String) do |v|
params.ylim = get_lim(v)
end
parsers[:density] = \
parsers[:d]
.on('--grid', TrueClass) do |v|
params.grid = v
end
.on('--xlim VAL', String) do |v|
params.xlim = get_lim(v)
end
.on('--ylim VAL', String) do |v|
params.ylim = get_lim(v)
end
parsers[:boxplot] = \
parsers[:box]
.on('--xlim VAL', String) do |v|
params.xlim = get_lim(v)
end
# Preventing the generation of new sub-commands
parsers.default = nil
# Usage and help messages
main_parser.banner = \
<<~MSG
Program: uplot (Tools for plotting on the terminal)
Version: #{Uplot::VERSION} (using unicode_plot #{UnicodePlot::VERSION})
Usage: uplot <command> [options]
Command: #{parsers.keys.join(' ')}
Options:
MSG
begin
main_parser.order!(argv)
rescue OptionParser::ParseError => e
warn "uplot: #{e.message}"
exit 1
end
@plot_type = argv.shift&.to_sym
unless parsers.has_key?(plot_type)
if plot_type.nil?
warn main_parser.help
else
warn "uplot: unrecognized command '#{plot_type}'"
end
exit 1
end
parser = parsers[plot_type]
begin
parser.parse!(argv) unless argv.empty?
rescue OptionParser::ParseError => e
warn "uplot: #{e.message}"
exit 1
end
end
def get_lim(str)
str.split(/-|:|\.\./)[0..1].map(&:to_f)
@parser = Parser.new
end
def run
parse_options
# Sometimes the input file does not end with a newline code.
while input = Kernel.gets(nil)
input.freeze
@raw_inputs << input
@data = Preprocessing.input(input, @delimiter, @headers, @transpose)
pp @data if @debug
case plot_type
when :bar, :barplot
Plot.barplot(data, params, @count)
when :count, :c
Plot.barplot(data, params, count = true)
when :hist, :histogram
Plot.histogram(data, params)
when :line, :lineplot
Plot.line(data, params)
when :lines, :lineplots
Plot.lines(data, params, fmt)
when :scatter, :s
Plot.scatter(data, params, fmt)
when :density, :d
Plot.density(data, params, fmt)
when :box, :boxplot
Plot.boxplot(data, params)
else
raise "unrecognized plot_type: #{plot_type}"
end.render($stderr)
parser.parse_options
command = parser.command
params = parser.params
delimiter = parser.delimiter
transpose = parser.transpose
headers = parser.headers
pass = parser.pass
output = parser.output
fmt = parser.fmt
@debug = parser.debug
print input if @output
if command == :colors
Plot.colors(parser.color_names)
exit
end
# Sometimes the input file does not end with a newline code.
while (input = Kernel.gets(nil))
input.freeze
@data = Preprocessing.input(input, delimiter, headers, transpose)
pp @data if @debug
plot = case command
when :bar, :barplot
Plot.barplot(data, params)
when :count, :c
Plot.barplot(data, params, count: true)
when :hist, :histogram
Plot.histogram(data, params)
when :line, :lineplot
Plot.line(data, params)
when :lines, :lineplots
Plot.lines(data, params, fmt)
when :scatter, :s
Plot.scatter(data, params, fmt)
when :density, :d
Plot.density(data, params, fmt)
when :box, :boxplot
Plot.boxplot(data, params)
else
raise "unrecognized plot_type: #{command}"
end
if output.is_a?(IO)
plot.render(output)
else
File.open(output, 'w') do |f|
plot.render(f)
end
end
if pass.is_a?(IO)
print input
elsif pass
File.open(pass, 'w') do |f|
f.print(input)
end
end
end
end
end

View File

@@ -0,0 +1,37 @@
# frozen_string_literal: true
module Uplot
class Command
# UnicodePlot parameters.
# * Normally in a Ruby program, you might use hash for the parameter object.
# * Here, I use Struct for 2 safety reason.
# * The keys are static in Struct.
# * Struct does not conflict with keyword arguments. Hash dose.
Params = Struct.new(
# Sort me!
:title,
:width,
:height,
:border,
:margin,
:padding,
:color,
:xlabel,
:ylabel,
:labels,
:symbol,
:xscale,
:nbins,
:closed,
:canvas,
:xlim,
:ylim,
:grid,
:name
) do
def to_hc
to_h.compact
end
end
end
end

261
lib/uplot/command/parser.rb Normal file
View File

@@ -0,0 +1,261 @@
# frozen_string_literal: true
require 'optparse'
require_relative 'params'
module Uplot
class Command
class Parser
attr_reader :command, :params,
:delimiter, :transpose, :headers, :pass, :output, :fmt,
:color_names, :debug
def initialize
@command = nil
@params = Params.new
@delimiter = "\t"
@transpose = false
@headers = nil
@pass = false
@output = $stderr
@fmt = 'xyy'
@debug = false
@color_names = false
end
def create_default_parser
OptionParser.new do |opt|
opt.program_name = 'uplot'
opt.version = Uplot::VERSION
opt.summary_width = 24
opt.on_tail('') # Add a blank line at the end
opt.separator('')
opt.on('Common options:')
opt.on('-O', '--pass [VAL]', 'file to output standard input data to [stdout]',
'for inserting uplot in the middle of Unix pipes') do |v|
@pass = v || $stdout
end
opt.on('-o', '--output VAL', 'file to output results to [stderr]') do |v|
@output = v
end
opt.on('-d', '--delimiter VAL', String, 'use DELIM instead of TAB for field delimiter') do |v|
@delimiter = v
end
opt.on('-H', '--headers', TrueClass, 'specify that the input has header row') do |v|
@headers = v
end
opt.on('-T', '--transpose', TrueClass, 'transpose the axes of the input data') do |v|
@transpose = v
end
opt.on('-t', '--title VAL', String, 'print string on the top of plot') do |v|
params.title = v
end
opt.on('-x', '--xlabel VAL', String, 'print string on the bottom of the plot') do |v|
params.xlabel = v
end
opt.on('-y', '--ylabel VAL', String, 'print string on the far left of the plot') do |v|
params.ylabel = v
end
opt.on('-w', '--width VAL', Integer, 'number of characters per row') do |v|
params.width = v
end
opt.on('-h', '--height VAL', Numeric, 'number of rows') do |v|
params.height = v
end
opt.on('-b', '--border VAL', String, 'specify the style of the bounding box') do |v|
params.border = v.to_sym
end
opt.on('-m', '--margin VAL', Numeric, 'number of spaces to the left of the plot') do |v|
params.margin = v
end
opt.on('-p', '--padding VAL', Numeric, 'space of the left and right of the plot') do |v|
params.padding = v
end
opt.on('-c', '--color VAL', String, 'color of the drawing') do |v|
params.color = v =~ /\A[0-9]+\z/ ? v.to_i : v.to_sym
end
opt.on('--[no-]labels', TrueClass, 'hide the labels') do |v|
params.labels = v
end
opt.on('--fmt VAL', String, 'xyxy : header is like x1, y1, x2, y2, x3, y3...', 'xyy : header is like x, y1, y2, y2, y3...') do |v|
@fmt = v
end
# Optparse adds the help option, but it doesn't show up in usage.
# This is why you need the code below.
opt.on('--help', 'print sub-command help menu') do
puts opt.help
exit
end
opt.on('--debug', TrueClass, 'print preprocessed data') do |v|
@debug = v
end
yield opt if block_given?
end
end
def main_parser
@main_parser ||= create_default_parser do |main_parser|
# Here, help message is stored in the banner.
# Because help of main_parser may be referred by `sub_parser`.
main_parser.banner = \
<<~MSG
Program: uplot (Tools for plotting on the terminal)
Version: #{Uplot::VERSION} (using UnicodePlot #{UnicodePlot::VERSION})
Source: https://github.com/kojix2/uplot
Usage: uplot <command> [options] <in.tsv>
Commands:
barplot bar draw a horizontal barplot
histogram hist draw a horizontal histogram
lineplot line draw a line chart
lineplots lines draw a line chart with multiple series
scatter s draw a scatter plot
density d draw a density plot
boxplot box draw a horizontal boxplot
colors show the list of available colors
count c draw a baplot based on the number of
occurrences (slow)
General options:
--help print command specific help menu
--version print the version of uplot
MSG
# Actually, main_parser can take common optional arguments.
# However, these options dose not be shown in the help menu.
# I think the main help should be simple.
main_parser.on('--help', 'print sub-command help menu') do
puts main_parser.banner
puts
exit
end
end
end
def sub_parser
@sub_parser ||= create_default_parser do |parser|
parser.banner = <<~MSG
Usage: uplot #{command} [options] <in.tsv>
Options for #{command}:
MSG
case command
# If you type only `uplot` in the terminal.
when nil
warn main_parser.banner
warn "\n"
exit 1
when :barplot, :bar
parser.on_head('--symbol VAL', String, 'character to be used to plot the bars') do |v|
params.symbol = v
end
parser.on_head('--xscale VAL', String, 'axis scaling') do |v|
params.xscale = v
end
when :count, :c
parser.on_head('--symbol VAL', String, 'character to be used to plot the bars') do |v|
params.symbol = v
end
when :histogram, :hist
parser.on_head('-n', '--nbins VAL', Numeric, 'approximate number of bins') do |v|
params.nbins = v
end
parser.on_head('--closed VAL', String) do |v|
params.closed = v
end
parser.on_head('--symbol VAL', String, 'character to be used to plot the bars') do |v|
params.symbol = v
end
when :lineplot, :line
parser.on_head('--canvas VAL', String, 'type of canvas') do |v|
params.canvas = v
end
parser.on_head('--xlim VAL', Array, 'plotting range for the x coordinate') do |v|
params.xlim = v.take(2)
end
parser.on_head('--ylim VAL', Array, 'plotting range for the y coordinate') do |v|
params.ylim = v.take(2)
end
when :lineplots, :lines
parser.on_head('--canvas VAL', String) do |v|
params.canvas = v
end
parser.on_head('--xlim VAL', Array, 'plotting range for the x coordinate') do |v|
params.xlim = v.take(2)
end
parser.on_head('--ylim VAL', Array, 'plotting range for the y coordinate') do |v|
params.ylim = v.take(2)
end
when :scatter, :s
parser.on_head('--canvas VAL', String) do |v|
params.canvas = v
end
parser.on_head('--xlim VAL', Array, 'plotting range for the x coordinate') do |v|
params.xlim = v.take(2)
end
parser.on_head('--ylim VAL', Array, 'plotting range for the y coordinate') do |v|
params.ylim = v.take(2)
end
when :density, :d
parser.on_head('--grid', TrueClass) do |v|
params.grid = v
end
parser.on_head('--xlim VAL', Array, 'plotting range for the x coordinate') do |v|
params.xlim = v.take(2)
end
parser.on_head('--ylim VAL', Array, 'plotting range for the y coordinate') do |v|
params.ylim = v.take(2)
end
when :boxplot, :box
parser.on_head('--xlim VAL', Array, 'plotting range for the x coordinate') do |v|
params.xlim = v.take(2)
end
when :colors
parser.on_head('-n', '--names', 'show color names only', TrueClass) do |v|
@color_names = v
end
else
warn "uplot: unrecognized command '#{command}'"
exit 1
end
end
end
def parse_options(argv = ARGV)
begin
main_parser.order!(argv)
rescue OptionParser::ParseError => e
warn "uplot: #{e.message}"
exit 1
end
@command = argv.shift&.to_sym
begin
sub_parser.parse!(argv)
rescue OptionParser::ParseError => e
warn "uplot: #{e.message}"
exit 1
end
end
end
end
end

View File

@@ -1,3 +1,5 @@
# frozen_string_literal: true
require 'unicode_plot'
module Uplot
@@ -5,16 +7,24 @@ module Uplot
module Plot
module_function
def barplot(data, params, count = false)
def barplot(data, params, count: false)
headers = data.headers
series = data.series
# `uplot count`
if count
series = Preprocessing.count(series[0])
series = Preprocessing.count_values(series[0])
params.title = headers[0] if headers
end
params.title ||= headers[1] if headers
labels = series[0]
values = series[1].map(&:to_f)
if series.size == 1
# If there is only one series, use the line number for label.
params.title ||= headers[0] if headers
labels = Array.new(series[0].size) { |i| (i + 1).to_s }
values = series[0].map(&:to_f)
else
params.title ||= headers[1] if headers
labels = series[0]
values = series[1].map(&:to_f)
end
UnicodePlot.barplot(labels, values, **params.to_hc)
end
@@ -48,10 +58,10 @@ module Uplot
end
def get_method2(method1)
(method1.to_s + '!').to_sym
"#{method1}!".to_sym
end
def xyy_plot(data, method1, params)
def plot_xyy(data, method1, params)
headers = data.headers
series = data.series
method2 = get_method2(method1)
@@ -68,7 +78,7 @@ module Uplot
plot
end
def xyxy_plot(data, method1, params)
def plot_xyxy(data, method1, params)
headers = data.headers
series = data.series
method2 = get_method2(method1)
@@ -85,34 +95,30 @@ module Uplot
plot
end
def lines(data, params, fmt = 'xyy')
check_series_size(data, fmt)
def plot_fmt(data, fmt, method1, params)
case fmt
when 'xyy'
xyy_plot(data, :lineplot, params)
plot_xyy(data, method1, params)
when 'xyxy'
xyxy_plot(data, :lineplot, params)
plot_xyxy(data, method1, params)
else
raise "Unknown format: #{fmt}"
end
end
def lines(data, params, fmt = 'xyy')
check_series_size(data, fmt)
plot_fmt(data, fmt, :lineplot, params)
end
def scatter(data, params, fmt = 'xyy')
check_series_size(data, fmt)
case fmt
when 'xyy'
xyy_plot(data, :scatterplot, params)
when 'xyxy'
xyxy_plot(data, :scatterplot, params)
end
plot_fmt(data, fmt, :scatterplot, params)
end
def density(data, params, fmt = 'xyy')
check_series_size(data, fmt)
case fmt
when 'xyy'
xyy_plot(data, :densityplot, params)
when 'xyxy'
xyxy_plot(data, :densityplot, params)
end
plot_fmt(data, fmt, :densityplot, params)
end
def boxplot(data, params)
@@ -123,6 +129,20 @@ module Uplot
UnicodePlot.boxplot(headers, series, **params.to_hc)
end
def colors(color_names = false)
UnicodePlot::StyledPrinter::TEXT_COLORS.each do |k, v|
print v
print k
unless color_names
print "\t"
print ' ●'
end
print "\033[0m"
print "\t"
end
puts
end
def check_series_size(data, fmt)
series = data.series
if series.size == 1

View File

@@ -1,3 +1,5 @@
# frozen_string_literal: true
require 'csv'
module Uplot
@@ -60,16 +62,14 @@ module Uplot
else
arr
end
elsif headers
transpose2(arr[1..-1])
else
if headers
transpose2(arr[1..-1])
else
transpose2(arr)
end
transpose2(arr)
end
end
def count(arr)
def count_values(arr)
# tally was added in Ruby 2.7
if Enumerable.method_defined? :tally
arr.tally

View File

@@ -1,3 +1,5 @@
# frozen_string_literal: true
module Uplot
VERSION = '0.2.2'.freeze
VERSION = '0.2.8'
end

View File

@@ -1,3 +1,5 @@
# frozen_string_literal: true
require 'simplecov'
SimpleCov.start

View File

@@ -1,4 +1,6 @@
require_relative '../test_helper.rb'
# frozen_string_literal: true
require_relative '../test_helper'
class UplotCommandTest < Test::Unit::TestCase
end

View File

@@ -1,4 +1,6 @@
require_relative '../test_helper.rb'
# frozen_string_literal: true
require_relative '../test_helper'
class UplotPlotTest < Test::Unit::TestCase
end

View File

@@ -1,4 +1,6 @@
require_relative '../test_helper.rb'
# frozen_string_literal: true
require_relative '../test_helper'
class UplotPreprocessingTest < Test::Unit::TestCase
def setup
@@ -61,7 +63,7 @@ class UplotPreprocessingTest < Test::Unit::TestCase
test :get_series do
n = nil
assert_equal([[2, 3], [5, 6], [8, 9]], @m.get_series([[1, 2, 3],
[4, 5, 6],
[7, 8, 9]], true, true))
@@ -123,8 +125,8 @@ class UplotPreprocessingTest < Test::Unit::TestCase
[3, 5, 6]], false, false))
end
test :count do
assert_equal([%i[a b c], [3, 2, 1]], @m.count(%i[a a a b b c]))
assert_equal([%i[c b a], [3, 2, 1]], @m.count(%i[a b b c c c]))
test :count_values do
assert_equal([%i[a b c], [3, 2, 1]], @m.count_values(%i[a a a b b c]))
assert_equal([%i[c b a], [3, 2, 1]], @m.count_values(%i[a b b c c c]))
end
end

View File

@@ -1,3 +1,5 @@
# frozen_string_literal: true
require 'test_helper'
class UplotTest < Test::Unit::TestCase

View File

@@ -1,3 +1,5 @@
# frozen_string_literal: true
require_relative 'lib/uplot/version'
Gem::Specification.new do |spec|
@@ -13,7 +15,7 @@ Gem::Specification.new do |spec|
MSG
spec.homepage = 'https://github.com/kojix2/uplot'
spec.license = 'MIT'
spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
spec.required_ruby_version = Gem::Requirement.new('>= 2.4.0')
spec.files = Dir['*.{md,txt}', '{lib,exe}/**/*']
spec.bindir = 'exe'