charty 0.2.0 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82f89899552044521a239ac75ec8b78aba5ef5ac0748c661953eab9bb96b422e
-  data.tar.gz: 143fe53c94b8a4b3b26e8fa8f6c763c350ce042995043e9c549418ca01be66bd
+  metadata.gz: 63e13663e8213e077993e52b906b630c35a1f7f9a224abb99fd206bb700659c2
+  data.tar.gz: d7fd53056c32c18bf5af6b1e1a4b2a29bfe652a427b338087d3cab538a0797ba
 SHA512:
-  metadata.gz: 8778ac8aabc6dbd533a8845978303c0d48a76ca502e2eb42f4fa7ec95a95025d0cf7245d92862f0d2bc29e9fad28f6aae58c8d75330c1061acb05342a10012be
-  data.tar.gz: 62cb81c64eb664babf597c7889e77a780a911651f7b062bc0bb9772d8c1d5f2d6b9b3b6b8797e8bec8e24cf50de7bca3bac729b665e948ee028a381751b10798
+  metadata.gz: cc4da146432f688eb52dd382ea516e02ab84ef7143453c80fa5bc14fef55851728550ee58fe98c1c3a5e9a1eac0f33dcfb702356bc7c0f344ceaf85f87400435
+  data.tar.gz: f519610073317c3fafd42b97ad5e96d124265f6a7d79a54023995cf82d1fe84624d4f914c26e3eef644ad280110400fe1cdac275ec5e32145d7e4b652ef47891

data/.github/workflows/ci.yml

@@ -0,0 +1,71 @@
+name: CI
+
+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
+        - ubuntu-18.04
+        ruby:
+        - "3.0"
+        - 2.7
+        - 2.6
+        include:
+        - { os: ubuntu-20.04 , ruby: head }
+
+    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 "nmatrix python"
+
+    - run: bundle exec rake
+
+    - run: rake build
+
+    - 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/Dockerfile.dev

@@ -1,2 +1,10 @@
-ARG BASE_IMAGE_TAG=c9ca70040856
+ARG BASE_IMAGE_TAG=e1a22a2
 FROM rubydata/minimal-notebook:$BASE_IMAGE_TAG
+
+USER root
+RUN mkdir -p /charty && \
+    chown ${NB_USER}:users /charty
+
+USER ${NB_USER}
+
+WORKDIR /charty

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
 ```
@@ -43,18 +45,184 @@ sudo python3 -m pip install -U pip matplotlib
 e.g.
 
 ```
-$ docker build -f ./Dockerfile.dev -t charty-dev:0.1 .
-$ docker run --rm -v ${PWD}:/charty -w /charty charty-dev:0.1 bundle install --path vendor/bundle
-$ docker run -it -v ${PWD}:/charty -w /charty charty-dev:0.1 ./bin/console
+$ docker build -f ./Dockerfile.dev -t charty-dev:latest .
+$ docker run --rm -v $(pwd):/charty charty-dev:latest bundle install
+$ docker run --rm -it -v $(pwd):/charty charty-dev:latest ./bin/console
 irb(main):001:0> Charty::VERSION
-=> "0.1.4-dev"
+=> "0.2.2"
 
 # When using jupyter notebook
-$ docker run -it -v ${PWD}:/charty -w /charty -p 8888:8888 charty-dev:0.1
+$ 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