charty 0.2.3 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2b78866e47f947e7cad0c06c3f53418ff07fa6fccce7941b53eb63f70cb8db0
-  data.tar.gz: 39c01144436ceee129c4d938ca8607b15c17292205f4f22da936442f89b2b2ca
+  metadata.gz: 0c245a8324486b73226c85162c602997c5b8e4f41c6fc03d731cd7c8c0e0c763
+  data.tar.gz: 720f08fdcf14ac5da11eace6f684d002c694de1d1b062fa9b954da4a286ae810
 SHA512:
-  metadata.gz: 3e83c4308b434b0e3b43e7ed083eefe249b46c3333be00501adee2bd299d4a6e34a78fa2c913f77876cf4ba1448468b553256cd68e22e8a0fe90b5d85b6daaec
-  data.tar.gz: e95895415c62bf352b6bdde4be7d04b7d12278a74a6e1e927376c99b2afc30a81c223e77c3f14848873d2f822233aa7557c4119471eba372af80d61db21756ba
+  metadata.gz: 253bf7b26d3ee72fe604afb4cdf50de412aa956171dc6671c33a158e2252597f71005fbbccb0f879f11688327339bf569f653f15eef6ac30faa4c0173765d607
+  data.tar.gz: b3cbfbd190a145c41db3d3fec8050f9ec4b9ddc12d978fb2c96a3a825409b708c8c0d6f14456ed0bf17f2c8150999ec063a1898d97b37c3e984a88645adc0d4b

data/.github/workflows/ci.yml

@@ -1,38 +1,71 @@
 name: CI
 
 on:
-- push
-- pull_request
+  push:
+    branches:
+    - master
+  pull_request:
+    types:
+    - opened
+    - synchronize
+    - reopened
 
 jobs:
   test:
-    name: Test
-
-    runs-on: ubuntu-latest
+    name: ${{ matrix.os }}/${{ matrix.ruby }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+        - ubuntu-20.04
+        - ubuntu-18.04
+        ruby:
+        - "3.0"
+        - 2.7
+        - 2.6
+        include:
+        - { os: ubuntu-20.04 , ruby: head }
 
     steps:
-    - uses: actions/checkout@v1
+    - uses: actions/checkout@v2
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
 
-    - name: Set up Ruby 2.6
-      uses: actions/setup-ruby@v1
+    - uses: actions/cache@v2
+      if: runner.os == 'Linux'
       with:
-        ruby-version: 2.6.x
+        path: ~/.cache/red-datasets
+        key: ${{ runner.os }}-${{ hashFiles('lib/**') }}
+        restore-keys: ${{ runner.os }}-
 
-    - name: Set up Python 3.7
-      uses: actions/setup-python@v1
+    - uses: actions/cache@v2
+      if: |
+        runner.os == 'macOS'
       with:
-        python-version: 3.7
+        path: |
+          ~/Library/Caches/red-datasets
+        key: ${{ runner.os }}-${{ hashFiles('lib/**') }}
+        restore-keys: ${{ runner.os }}-
+
+    - uses: actions/cache@v2
+      if: |
+        runner.os == 'Windows'
+      with:
+        path: |
+          ~/AppData/red-datasets
+        key: ${{ runner.os }}-${{ hashFiles('lib/**') }}
+        restore-keys: ${{ runner.os }}-
+
+    - run: sudo apt install build-essential libsqlite3-dev
+
+    - run: bundle install --jobs 4 --retry 3 --without "nmatrix python"
 
-    - name: Install dependencies
-      run: |
-        sudo apt install build-essential libsqlite3-dev
+    - run: bundle exec rake
 
-    - name: Install matplotlib
-      run: |
-        pip install --user matplotlib
+    - run: rake build
 
-    - name: Build and test with Rake
-      run: |
-        gem install bundler
-        bundle install --jobs 4 --retry 3
-        bundle exec rake
+    - run: gem install --user pkg/*.gem

data/.github/workflows/nmatrix.yml

@@ -0,0 +1,67 @@
+name: CI with NMatrix
+
+on:
+  push:
+    branches:
+    - master
+  pull_request:
+    types:
+    - opened
+    - synchronize
+    - reopened
+
+jobs:
+  test:
+    name: ${{ matrix.os }}/${{ matrix.ruby }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+        - ubuntu-20.04
+        ruby:
+        - 2.7
+        - 2.6
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+
+    - uses: actions/cache@v2
+      if: runner.os == 'Linux'
+      with:
+        path: ~/.cache/red-datasets
+        key: ${{ runner.os }}-${{ hashFiles('lib/**') }}
+        restore-keys: ${{ runner.os }}-
+
+    - uses: actions/cache@v2
+      if: |
+        runner.os == 'macOS'
+      with:
+        path: |
+          ~/Library/Caches/red-datasets
+        key: ${{ runner.os }}-${{ hashFiles('lib/**') }}
+        restore-keys: ${{ runner.os }}-
+
+    - uses: actions/cache@v2
+      if: |
+        runner.os == 'Windows'
+      with:
+        path: |
+          ~/AppData/red-datasets
+        key: ${{ runner.os }}-${{ hashFiles('lib/**') }}
+        restore-keys: ${{ runner.os }}-
+
+    - run: sudo apt install build-essential libsqlite3-dev
+
+    - run: bundle install --jobs 4 --retry 3 --without "numo python"
+
+    - run: bundle exec rake
+
+    - run: rake build
+
+    - run: gem install --user pkg/*.gem

data/.github/workflows/pycall.yml

@@ -0,0 +1,86 @@
+name: CI with matplotlib and pandas
+
+on:
+  push:
+    branches:
+    - master
+  pull_request:
+    types:
+    - opened
+    - synchronize
+    - reopened
+
+jobs:
+  test:
+    name: ${{ matrix.os }}/${{ matrix.ruby }}/${{ matrix.python }}-${{ matrix.python_architecture }}
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+        - ubuntu-20.04
+        - ubuntu-18.04
+        ruby:
+        - "3.0"
+        - 2.7
+        - 2.6
+        python:
+        - 3.x
+        - 2.x
+        python_architecture:
+        - x64
+        include:
+        - { os: ubuntu-20.04 , ruby: head , python: 3.x , python_architecture: x64 }
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Setup Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+
+    - name: Setup Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python }}
+        architecture: ${{ matrix.python_architecture }}
+
+    - uses: actions/cache@v2
+      if: runner.os == 'Linux'
+      with:
+        path: ~/.cache/red-datasets
+        key: ${{ runner.os }}-${{ hashFiles('lib/**') }}
+        restore-keys: ${{ runner.os }}-
+
+    - uses: actions/cache@v2
+      if: |
+        runner.os == 'macOS'
+      with:
+        path: |
+          ~/Library/Caches/red-datasets
+          key: ${{ runner.os }}-${{ hashFiles('lib/**') }}
+          restore-keys: ${{ runner.os }}-
+
+    - uses: actions/cache@v2
+      if: |
+        runner.os == 'Windows'
+      with:
+        path: |
+          ~/AppData/red-datasets
+        key: ${{ runner.os }}-${{ hashFiles('lib/**') }}
+        restore-keys: ${{ runner.os }}-
+
+    - run: sudo apt install build-essential libsqlite3-dev
+
+    - run: pip install --user matplotlib pandas
+
+    - run: bundle install --jobs 4 --retry 3 --without "nmatrix numo"
+
+    - run: python -V
+
+    - run: bundle exec rake
+      env:
+        PYTHON: python
+      continue-on-error: ${{ matrix.python == '2.x' }}

data/Gemfile

@@ -4,3 +4,21 @@ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in charty.gemspec
 gemspec
+
+group :cruby do
+  gem "enumerable-statistics"
+end
+
+group :nmatrix do
+  gem "nmatrix"
+end
+
+group :numo do
+  gem "numo-narray"
+end
+
+group :python do
+  gem "matplotlib"
+  gem "numpy"
+  gem "pandas"
+end

data/README.md

@@ -1,7 +1,9 @@
 # Charty - Visualizing your data in Ruby
 
-[![Build Status](https://travis-ci.org/red-data-tools/charty.svg?branch=master)](https://travis-ci.org/red-data-tools/charty)
+![Build Status](https://github.com/red-data-tools/charty/workflows/CI/badge.svg)
+[![Gem Version](https://badge.fury.io/rb/charty.svg)](https://badge.fury.io/rb/charty)
 [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/red-data-tools/charty/master?filepath=iris_dataset.ipynb)
+[![Docs](https://img.shields.io/badge/docs-stable-blue.svg)](https://rubydoc.info/gems/charty)
 
 Charty is open-source Ruby library for visualizing your data in a simple way.
 In Charty, you need to write very few lines of code for representing what you want to do.
@@ -32,8 +34,8 @@ $ CONFIGURE_OPTS="--enable-shared" pyenv install 3.x.x
 ### With Matplotlib
 
 ```
-sudo gem install charty --pre
-sudo gem install matplotlib
+gem install charty --pre
+gem install matplotlib
 sudo apt install python3-pip
 sudo python3 -m pip install -U pip matplotlib
 ```
@@ -55,6 +57,172 @@ $ docker run --rm -it -v $(pwd):/charty -p 8888:8888 charty-dev:latest
 
 ## Usage
 
+### Statistical plotting interface
+
+Charty supports statistical plotting as Python's seaborn.
+
+In the following examplles, we use the `penguins` dataset provided in red-datasets.
+
+```ruby
+require "datasets"
+
+penguins = Datasets::Penguins.new
+```
+
+#### A basic workflow
+
+The following code shows a basic workflow of the visualization with Charty.
+
+First you need to load the Charty library.
+
+```ruby
+require "charty"
+```
+
+Next you msut have a dataset you want to visualize.  Here, we use the penguins dataset provided in red-datasets library.
+
+```ruby
+require "datasets"
+penguins = Datasets::Penguins.new
+```
+
+Next you need to create a plotter object by a plotting method.  Here, we use `scatter_plot` method to show the relationship
+among `body_mass_g`, `flipper_length_mm`, and `species` columns in the penguins dataset.
+
+```ruby
+plot = Charty.scatter_plot(data: penguins, x: :body_mass_g, y: :flipper_length_mm, color: :species)
+```
+
+If you want to render and save this plotter object into an HTML file by plotly backend, you can do it like below.
+
+```ruby
+Charty::Backends.use(:plotly)  # select plotly backend
+plot.save("scatter.html")      # save the plot as  an HTML file
+```
+
+When you already have prepared [playwright-ruby-client](https://github.com/YusukeIwaki/playwright-ruby-client),
+you can render a plot into a PNG file by plotly backend by specifying a filename with `.png` extension.
+
+```ruby
+plot.save("scatter.png")
+```
+
+#### Jupyter Notebook
+
+If you use Charty on Jupyter Notebook with IRuby kerenl (a.k.a. IRuby notebook),
+you can render the plot just evaluate a plotter object.  For example, the code below shows a scatter plot figure in
+the output area.
+
+```ruby
+Charty::Backends.use(:plotly)
+
+Charty.scatter_plot(data: penguins, x: :body_mass_g, y: :flipper_length_mm, color: :species)
+```
+
+Note that if you want to use the pyplot backend, you need to activate the integration between the pyplot backend and IRuby.
+You can activate the integration by the following two lines.
+
+```ruby
+Charty::Backends.use(:pyplot)
+Charty::Backends::Pyplot.activate_iruby_integration
+```
+
+#### Bar plot
+
+Charty's statistical bar plot shows the relationship between a categorical variable and estimated means of a numeric variable.
+This plot automatically calculates mean estimation and its 95% confidence interval of the numeric variable.
+
+When we specify the categorical varaible as x-axis, the plot draws a vertical bar chart.
+Instead, when we specify the categorical variable as y-axis, the plot draws a horizontal bar chart.
+
+The following code shows the relationship between species and the mean body masses of penguins in a vertical bar chart.
+
+```ruby
+Charty.bar_plot(data: penguins, x: :species, y: :body_mass_g)
+```
+
+![](images/penguins_species_body_mass_g_bar_plot_v.png)
+
+Exchanging x and y axes alternates the orientation of the resulting chart.
+
+```ruby
+Charty.bar_plot(data: penguins, x: :body_mass_g, y: :species)
+```
+
+![](images/penguins_species_body_mass_g_bar_plot_h.png)
+
+Adding color axis introduces color grouping in the bar plot.
+
+```ruby
+Charty.bar_plot(data: penguins, x: :species, y: :body_mass_g, color: :sex)
+```
+
+![](images/penguins_species_body_mass_g_sex_bar_plot_v.png)
+
+#### Box plot
+
+Charty's statistical box plot shows distributions of a numeric variable per categories.
+The distributions are showed by boxes with whiskers that characterized by five-number summary.
+This plot automatically calculates five-number summary the numeric variable per categories.
+
+When we specify the categorical varaible as x-axis, the plot draws a vertical box plot chart.
+Instead, when we specify the categorical variable as y-axis, the plot draws a horizontal box plot chart.
+
+The following code draws a vertical box plot to show distributions of penguins' body mass per species.
+
+```ruby
+Charty.box_plot(data: penguins, x: :species, y: :body_mass_g)
+```
+
+![](images/penguins_species_body_mass_g_box_plot_v.png)
+
+As `bar_plot` above, exchanging x and y axes alternates the orientation of the resulting chart.
+
+```ruby
+Charty.box_plot(data: penguins, x: :body_mass_g, y: :species)
+```
+
+![](images/penguins_species_body_mass_g_box_plot_h.png)
+
+Adding color axis introduces color grouping in the box plot.
+
+```ruby
+Charty.box_plot(data: penguins, x: :species, y: :body_mass_g, color: :sex)
+```
+
+![](images/penguins_species_body_mass_g_sex_box_plot_v.png)
+
+#### Scatter plot
+
+Charty's scatter plot shows the relationship between two numeric variables.
+
+```ruby
+Charty.scatter_plot(data: penguins, x: :body_mass_g, y: flipper_length_mm)
+```
+
+![](images/penguins_body_mass_g_flipper_length_mm_scatter_plot.png)
+
+Adding color axis introduces color grouping in the scatter plot.
+The following example specifies `:species` variable in the color axis.
+It shows the different species by the different colors.
+
+```ruby
+Charty.scatter_plot(data: penguins, x: :body_mass_g, y: flipper_length_mm, color: :species)
+```
+
+![](images/penguins_body_mass_g_flipper_length_mm_species_scatter_plot.png)
+
+Moreover, size and style axes can be specified.
+The following example specifies `:sex` variable in the style axis.
+
+```ruby
+Charty.scatter_plot(data: penguins, x: :body_mass_g, y: flipper_length_mm, color: :species, style: :sex)
+```
+
+![](images/penguins_body_mass_g_flipper_length_mm_species_sex_scatter_plot.png)
+
+### Old-style plotting interface
+
 ```ruby
 require 'charty'
 charty = Charty::Plotter.new(:pyplot)
@@ -354,7 +522,7 @@ hist.render("sample_images/hist_pyplot.png")
 
 #### Gruff
 
-Not supported
+![hist_gruff](https://raw.githubusercontent.com/red-data-tools/charty/master/examples/sample_images/hist_gruff.png)
 
 #### Rubyplot