charty 0.2.7 → 0.2.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e39148cc6e6fd7916cdfbe5dacda3bab8f95068cbe3ceb4dff673d9688487d0
-  data.tar.gz: 5743d17f30055707fe39004f99bb30fb2cb10b164dbf9b222f000068cc800708
+  metadata.gz: eac796ba17aeb9a82a312d7099c898a2350abaf34c3fad80ea1afd1483de1797
+  data.tar.gz: 8001339bd86377ab3693cc2eeb0a826c04c4ea4e08d58e3a10e99849a273cd58
 SHA512:
-  metadata.gz: 562b312fb4ca59995d19930f404d6162f432f7731752e5a9016132b6b2696a507f6d7523d5eb6e5bc0141273726d2608b1351b497f2c200cec0fda5204e4fc19
-  data.tar.gz: 213f83930bc1bd809ae98af41d0608793c356b234064e9f2ec79b96e76b1c301a331fc44c9c04fc0f3f188f65b780b59af449dca206f68ec310cb121b6bd0e41
+  metadata.gz: 3679334bb56834f7fb1067878c60e7601375e05d6adf63e566eb2cd3847a7ce1423bb27d0104f666854c8343840706a8e14dcc12bc8420ae062b8144d3f6ebc2
+  data.tar.gz: f4bbec96ae815cd758b67a993355fe5e42a10b91d7ef351e63570ec84fa618e65e4c2df4006f2d3431738c8b82b6a5dcf74d79a9b4ce005f89f18fd2ae88d31d

data/charty.gemspec

@@ -42,4 +42,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "activerecord"
   spec.add_development_dependency "sqlite3"
   spec.add_development_dependency "iruby", ">= 0.7.0"
+  spec.add_development_dependency "csv"
 end

data/examples/bar_plot.rb

@@ -0,0 +1,19 @@
+# This example generates box_plot results in README.md
+
+require "charty"
+require "datasets"
+require "matplotlib"
+
+Charty::Backends.use(:pyplot)
+Matplotlib.use(:agg)
+
+penguins = Datasets::Penguins.new
+
+Charty.bar_plot(data: penguins, x: :species, y: :body_mass_g)
+      .save("penguins_species_body_mass_g_bar_plot_v.png")
+
+Charty.bar_plot(data: penguins, x: :body_mass_g, y: :species)
+      .save("penguins_species_body_mass_g_bar_plot_h.png")
+
+Charty.bar_plot(data: penguins, x: :species, y: :body_mass_g, color: :sex)
+      .save("penguins_species_body_mass_g_sex_bar_plot_v.png")

data/examples/box_plot.rb

@@ -0,0 +1,17 @@
+require "charty"
+require "datasets"
+require "matplotlib"
+
+Charty::Backends.use(:pyplot)
+Matplotlib.use(:agg)
+
+penguins = Datasets::Penguins.new
+
+Charty.box_plot(data: penguins, x: :species, y: :body_mass_g)
+      .save("penguins_species_body_mass_g_box_plot_v.png")
+
+Charty.box_plot(data: penguins, x: :body_mass_g, y: :species)
+      .save("penguins_species_body_mass_g_box_plot_h.png")
+
+Charty.box_plot(data: penguins, x: :species, y: :body_mass_g, color: :sex)
+      .save("penguins_species_body_mass_g_sex_box_plot_v.png")

data/examples/scatter_plot.rb

@@ -0,0 +1,17 @@
+require "charty"
+require "datasets"
+require "matplotlib"
+
+Charty::Backends.use(:pyplot)
+Matplotlib.use(:agg)
+
+penguins = Datasets::Penguins.new
+
+Charty.scatter_plot(data: penguins, x: :body_mass_g, y: :flipper_length_mm)
+      .save("penguins_body_mass_g_flipper_length_mm_scatter_plot.png")
+
+Charty.scatter_plot(data: penguins, x: :body_mass_g, y: :flipper_length_mm, color: :species)
+      .save("penguins_body_mass_g_flipper_length_mm_species_scatter_plot.png")
+
+Charty.scatter_plot(data: penguins, x: :body_mass_g, y: :flipper_length_mm, color: :species, style: :sex)
+      .save("penguins_body_mass_g_flipper_length_mm_species_sex_scatter_plot.png")

data/lib/charty/backends/plotly.rb

@@ -134,10 +134,8 @@ module Charty
 
         if orient == :v
           x, y = bar_pos, values
-          x = group_names unless group_names.nil?
         else
           x, y = values, bar_pos
-          y = group_names unless group_names.nil?
         end
 
         trace = {
@@ -241,9 +239,9 @@ module Charty
           }
 
           if orient == :v
-            trace.update(y: values, x: group_keys)
+            trace.update(y: values, x: group_keys.map(&:to_s))
           else
-            trace.update(x: values, y: group_keys)
+            trace.update(x: values, y: group_keys.map(&:to_s))
           end
 
           trace
@@ -569,30 +567,35 @@ module Charty
         probability: "probability".freeze
       }.freeze
 
-      def univariate_histogram(data, name, variable_name, stat,
-                               bin_start, bin_end, bin_size, alpha,
-                               color, color_mapper)
-        orientation = case variable_name
-                      when :x
-                        :v
-                      else
-                        :h
-                      end
+      def univariate_histogram(hist, name, variable_name, stat,
+                               alpha, color, key_color, color_mapper,
+                               _multiple, _element, _fill, _shrink)
+        value_axis = variable_name
+        case value_axis
+        when :x
+          weights_axis = :y
+          orientation = :v
+        else
+          weights_axis = :x
+          orientation = :h
+        end
+
+        mid_points = hist.edges.each_cons(2).map {|a, b| a + (b - a) / 2 }
+
         trace = {
-          type: "histogram",
+          type: :bar,
           name: name.to_s,
-          variable_name => data.to_a,
+          value_axis => mid_points,
+          weights_axis => hist.weights,
           orientation: orientation,
-          histnorm: PLOTLY_HISTNORM[stat],
-          "#{variable_name}bins": {
-            start: bin_start,
-            end: bin_end,
-            size: bin_size
-          },
           opacity: alpha
         }
 
-        if color
+        if color.nil?
+          trace[:marker] = {
+            color: key_color.to_rgb.to_hex_string
+          }
+        else
           trace[:marker] = {
             color: color_mapper[color].to_rgb.to_hex_string
           }
@@ -608,6 +611,11 @@ module Charty
         end
       end
 
+      def set_title(title)
+        @layout[:title] ||= {}
+        @layout[:title][:text] = title
+      end
+
       def set_xlabel(label)
         @layout[:xaxis] ||= {}
         @layout[:xaxis][:title] = label
@@ -652,6 +660,29 @@ module Charty
         @layout[:yaxis][:range] = [min, max]
       end
 
+      def set_xscale(scale)
+        scale = check_scale_type(scale, :xscale)
+        @layout[:xaxis] ||= {}
+        @layout[:xaxis][:type] = scale
+      end
+
+      def set_yscale(scale)
+        scale = check_scale_type(scale, :yscale)
+        @layout[:yaxis] ||= {}
+        @layout[:yaxis][:type] = scale
+      end
+
+      private def check_scale_type(val, name)
+        case
+        when :linear, :log
+          val
+        else
+          raise ArgumentError,
+                "Invalid #{name} type: %p" % val,
+                caller
+        end
+      end
+
       def disable_xaxis_grid
         # do nothing
       end

data/lib/charty/backends/plotly_helpers/notebook_renderer.rb

@@ -7,7 +7,7 @@ module Charty
           @initialized = false
         end
 
-        def activate()
+        def activate
           return if @initialized
 
           unless IRubyHelper.iruby_notebook?
@@ -49,6 +49,9 @@ module Charty
               </script>
             END_SCRIPT
           end
+          IRuby.display(script, mime: "text/html")
+          @initialized = true
+          nil
         end
 
         def render(figure, element_id: nil, post_script: nil)

data/lib/charty/backends/pyplot.rb

@@ -14,6 +14,7 @@ module Charty
 
       def initialize
         @pyplot = ::Matplotlib::Pyplot
+        @default_edgecolor = Colors["white"].to_rgb
         @default_line_width = ::Matplotlib.rcParams["lines.linewidth"]
         @default_marker_size = ::Matplotlib.rcParams["lines.markersize"]
       end
@@ -575,6 +576,47 @@ module Charty
         min + x * (max - min)
       end
 
+      def univariate_histogram(hist, name, variable_name, stat,
+                               alpha, color, key_color, color_mapper,
+                               multiple, element, fill, shrink)
+        mid_points = hist.edges.each_cons(2).map {|a, b| a + (b - a) / 2 }
+        orient = variable_name == :x ? :v : :h
+        width = shrink * (hist.edges[1] - hist.edges[0])
+
+        kw = {align: :edge}
+
+        color = if color.nil?
+                  key_color.to_rgb
+                else
+                  color_mapper[color].to_rgb
+                end
+
+        alpha = 1r unless fill
+
+        if fill
+          kw[:facecolor] = color.to_rgba(alpha: alpha).to_hex_string
+          if multiple == :stack || multiple == :fill || element == :bars
+            kw[:edgecolor] = @default_edgecolor.to_hex_string
+          else
+            kw[:edgecolor] = color.to_hex_string
+          end
+        elsif element == :bars
+          kw.delete(:facecolor)
+          kw[:edgecolor] = color.to_rgba(alpha: alpha).to_hex_string
+        else
+          kw[:color] = color.to_rgba(alpha: alpha).to_hex_string
+        end
+
+        kw[:label] = name unless name.nil?
+
+        ax = @pyplot.gca
+        if orient == :v
+          ax.bar(mid_points, hist.weights, width, **kw)
+        else
+          ax.barh(mid_points, hist.weights, width, **kw)
+        end
+      end
+
       private def locator_to_legend_entries(locator, limits)
         vmin, vmax = limits
         dtype = case vmin
@@ -620,6 +662,10 @@ module Charty
         end
       end
 
+      def set_title(title)
+        @pyplot.gca.set_title(String(title))
+      end
+
       def set_xlabel(label)
         @pyplot.gca.set_xlabel(String(label))
       end
@@ -652,6 +698,27 @@ module Charty
         @pyplot.gca.set_ylim(Float(min), Float(max))
       end
 
+      def set_xscale(scale)
+        scale = check_scale_type(scale, :xscale)
+        @pyplot.gca.set_xscale(scale)
+      end
+
+      def set_yscale(scale)
+        scale = check_scale_type(scale, :yscale)
+        @pyplot.gca.set_yscale(scale)
+      end
+
+      private def check_scale_type(val, name)
+        case
+        when :linear, :log
+          val
+        else
+          raise ArgumentError,
+                "Invalid #{name} type: %p" % val,
+                caller
+        end
+      end
+
       def disable_xaxis_grid
         @pyplot.gca.xaxis.grid(false)
       end
@@ -673,6 +740,11 @@ module Charty
         nil
       end
 
+      def render_mimebundle(include: [], exclude: [])
+        show
+        {}
+      end
+
       SAVEFIG_OPTIONAL_PARAMS = [
         :dpi, :quality, :optimize, :progressive, :facecolor, :edgecolor,
         :orientation, :papertype, :transparent, :bbox_inches, :pad_inches,
@@ -686,6 +758,7 @@ module Charty
           params[key] = kwargs[key] if kwargs.key?(key)
         end
         @pyplot.savefig(filename, **params)
+        @pyplot.close
       end
 
       def show

data/lib/charty/backends/unicode_plot.rb

@@ -16,16 +16,16 @@ module Charty
         @layout = {}
       end
 
-      def bar(bar_pos, values, color: nil)
+      def bar(bar_pos, _group_names, values, colors, _orient, **kwargs)
         @figure = {
           type: :bar,
           bar_pos: bar_pos,
-          values: values
+          values: values,
         }
       end
 
-      def box_plot(plot_data, positions, color:, gray:)
-        @figure = { type: :box, data: plot_data }
+      def box_plot(plot_data, positions, orient:, **kwargs)
+        @figure = { type: :box, data: plot_data, orient: orient }
       end
 
       def set_xlabel(label)
@@ -52,13 +52,18 @@ module Charty
         # do nothing
       end
 
-      def show
-        case @figure[:type]
-        when :bar
-          plot = ::UnicodePlot.barplot(@layout[:xtick_labels], @figure[:values], xlabel: @layout[:xlabel])
-        when :box
-          plot = ::UnicodePlot.boxplot(@layout[:xtick_labels], @figure[:data], xlabel: @layout[:xlabel])
-        end
+      def render(**kwargs)
+        plot = case @figure[:type]
+                when :bar
+                  ::UnicodePlot.barplot(@layout[:xtick_labels], @figure[:values], xlabel: @layout[:xlabel])
+                when :box
+                  xlabel = if @figure[:orient] == :v
+                             @layout[:ylabel]
+                           else
+                             @layout[:xlabel]
+                           end
+                  ::UnicodePlot.boxplot(@layout[:xtick_labels], @figure[:data], xlabel: xlabel)
+                end
         sio = StringIO.new
         class << sio
           def tty?; true; end

data/lib/charty/index.rb

@@ -199,6 +199,15 @@ module Charty
       end
     end
 
+    def loc(key)
+      case values
+      when Pandas::Index
+        values.get_loc(key)
+      else
+        super
+      end
+    end
+
     def union(other)
       other = PandasIndex.try_convert(other)
       # NOTE: Using `sort=False` in pandas.Index#union does not produce pandas.RangeIndex.

data/lib/charty/plot_methods.rb

@@ -23,19 +23,24 @@ module Charty
     # @param cap_size  Width of the caps on error bars.
     # @param dodge  [true,false]  If true, bar position is shifted along the
     #        categorical axis for avoid overlapping when the color-dimension is used.
+    # @param log  [true,false]  Set the value-axis (e.g. Y-axis if orient is :v) to be log scale.
+    # @param x_label [String,Symbol,#to_str,nil]  X-axis label.
+    # @param y_label [String,Symbol,#to_str,nil]  Y-axis label.
+    # @param title [String,Symbol,#to_str,nil]  Title text.
     def bar_plot(x: nil, y: nil, color: nil, data: nil,
                  order: nil, color_order: nil,
                  estimator: :mean, ci: 95, n_boot: 1000, units: nil, random: nil,
                  orient: nil, key_color: nil, palette: nil, saturation: 1r,
                  error_color: [0.26, 0.26, 0.26], error_width: nil, cap_size: nil,
-                 dodge: true, **options, &block)
+                 dodge: true, log: false, x_label: nil, y_label: nil, title: nil,
+                 **options, &block)
       Plotters::BarPlotter.new(
         data: data, variables: { x: x, y: y, color: color },
         order: order, orient: orient,
         estimator: estimator, ci: ci, n_boot: n_boot, units: units, random: random,
         color_order: color_order, key_color: key_color, palette: palette, saturation: saturation,
         error_color: error_color, error_width: error_width, cap_size: cap_size,
-        dodge: dodge,
+        dodge: dodge, log: log, x_label: x_label, y_label: y_label, title: title,
         **options, &block
       )
     end
@@ -43,7 +48,8 @@ module Charty
     def count_plot(x: nil, y: nil, color: nil, data: nil,
                    order: nil, color_order: nil,
                    orient: nil, key_color: nil, palette: nil, saturation: 1r,
-                   dodge: true, **options, &block)
+                   dodge: true, log: false, x_label: nil, y_label: nil, title: nil,
+                   **options, &block)
       case
       when x.nil? && !y.nil?
         x = y
@@ -70,6 +76,9 @@ module Charty
         palette: palette,
         saturation: saturation,
         dodge: dodge,
+        x_label: x_label,
+        y_label: y_label,
+        title: title,
         **options
       ) do |plotter|
         plotter.value_label = "count"
@@ -106,11 +115,15 @@ module Charty
     # @param whisker  Propotion of the IQR past the low and high quartiles to
     #        extend the plot whiskers.  Points outside of this range will be
     #        treated as outliers.
+    # @param x_label [String,Symbol,#to_str,nil]  X-axis label.
+    # @param y_label [String,Symbol,#to_str,nil]  Y-axis label.
+    # @param title [String,Symbol,#to_str,nil]  Title text.
     def box_plot(x: nil, y: nil, color: nil, data: nil,
                  order: nil, color_order: nil,
                  orient: nil, key_color: nil, palette: nil, saturation: 1r,
                  width: 0.8r, dodge: true, flier_size: 5, line_width: nil,
-                 whisker: 1.5, **options, &block)
+                 whisker: 1.5, x_label: nil, y_label: nil, title: nil,
+                 **options, &block)
       Plotters::BoxPlotter.new(
         data: data,
         variables: { x: x, y: y, color: color },
@@ -125,6 +138,9 @@ module Charty
         flier_size: flier_size,
         line_width: line_width,
         whisker: whisker,
+        x_label: x_label,
+        y_label: y_label,
+        title: title,
         **options,
         &block
       )
@@ -164,13 +180,18 @@ module Charty
     #        :full, every group will get an entry in the legend.  If :auto,
     #        choose between brief or full representation based on number of
     #        levels.  If false, no legend data is added and no legend is drawn.
+    # @param x_label [String,Symbol,#to_str,nil]  X-axis label.
+    # @param y_label [String,Symbol,#to_str,nil]  Y-axis label.
+    # @param title [String,Symbol,#to_str,nil]  Title text.
     def line_plot(x: nil, y: nil, color: nil, style: nil, size: nil,
                   data: nil, key_color: nil, palette: nil, color_order: nil,
                   color_norm: nil, sizes: nil, size_order: nil, size_norm: nil,
                   markers: nil, dashes: true, style_order: nil,
                   units: nil, estimator: :mean, n_boot: 1000, random: nil,
                   sort: true, err_style: :band, err_params: nil, error_bar: [:ci, 95],
-                  x_scale: :linear, y_scale: :linear, legend: :auto, **options, &block)
+                  x_scale: :linear, y_scale: :linear, legend: :auto,
+                  x_label: nil, y_label: nil, title: nil,
+                  **options, &block)
       Plotters::LinePlotter.new(
         data: data,
         variables: { x: x, y: y, color: color, style: style, size: size },
@@ -195,6 +216,9 @@ module Charty
         x_scale: x_scale,
         y_scale: y_scale,
         legend: legend,
+        x_label: x_label,
+        y_label: y_label,
+        title: title,
         **options,
         &block
       )
@@ -225,11 +249,14 @@ module Charty
     #        :full, every group will get an entry in the legend.  If :auto,
     #        choose between brief or full representation based on number of
     #        levels.  If false, no legend data is added and no legend is drawn.
+    # @param x_label [String,Symbol,#to_str,nil]  X-axis label.
+    # @param y_label [String,Symbol,#to_str,nil]  Y-axis label.
+    # @param title [String,Symbol,#to_str,nil]  Title text.
     def scatter_plot(x: nil, y: nil, color: nil, style: nil, size: nil,
                      data: nil, key_color: nil, palette: nil, color_order: nil,
                      color_norm: nil, sizes: nil, size_order: nil, size_norm: nil,
                      markers: true, style_order: nil, alpha: nil, legend: :auto,
-                     **options, &block)
+                     x_label: nil, y_label: nil, title: nil, **options, &block)
       Plotters::ScatterPlotter.new(
         data: data,
         variables: { x: x, y: y, color: color, style: style, size: size },
@@ -244,22 +271,25 @@ module Charty
         style_order: style_order,
         alpha: alpha,
         legend: legend,
+        x_label: x_label,
+        y_label: y_label,
+        title: title,
         **options,
         &block
       )
     end
 
-    def hist_plot(data: nil, x: nil, y: nil, color: nil,
+    def hist_plot(data: nil, x: nil, y: nil, color: nil, weights: nil,
                   stat: :count, bins: :auto,
+                  bin_range: nil, common_bins: true,
                   key_color: nil, palette: nil, color_order: nil, color_norm: nil,
-                  legend: true, **options, &block)
+                  legend: true, x_label: nil, y_label: nil, title: nil,
+                  **options, &block)
       # TODO: support following arguments
       # - wiehgts
       # - binwidth
-      # - binrange
       # - discrete
       # - cumulative
-      # - common_bins
       # - common_norm
       # - multiple
       # - element
@@ -278,13 +308,19 @@ module Charty
       Plotters::HistogramPlotter.new(
         data: data,
         variables: { x: x, y: y, color: color },
+        weights: weights,
         stat: stat,
         bins: bins,
+        bin_range: bin_range,
+        common_bins: common_bins,
         key_color: key_color,
         palette: palette,
         color_order: color_order,
         color_norm: color_norm,
         legend: legend,
+        x_label: x_label,
+        y_label: y_label,
+        title: title,
         **options,
         &block)
     end