rbplotly 0.1.2 → 1.0.0

data/examples/heatmaps.ipynb

@@ -1,150 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "code",
-   "execution_count": 1,
-   "metadata": {
-    "collapsed": false,
-    "scrolled": true
-   },
-   "outputs": [
-    {
-     "data": {
-      "text/html": [
-       "\n",
-       "  <script>\n",
-       "  requirejs.config({paths: { 'plotly': ['https://cdn.plot.ly/plotly-latest.min'] }})\n",
-       "  </script>\n",
-       "\n",
-       "\n",
-       "<div id=\"538b8031-8157-4473-aaab-221d4569c87b\" style=\"height: 100%; width: 100%;\"></div>\n",
-       "\n",
-       "<script>\n",
-       " require(['plotly'], function(Plotly) { \n",
-       "Plotly.newPlot(\n",
-       "  '538b8031-8157-4473-aaab-221d4569c87b',\n",
-       "  [{\"z\":[[1,20,30],[20,1,60],[30,60,1]],\"type\":\"heatmap\"}],\n",
-       "  {},\n",
-       "  {\"linkText\":\"Export to plot.ly\",\"showLink\":true}\n",
-       ")\n",
-       "\n",
-       "window.addEventListener('resize', function() {\n",
-       "  Plotly.Plots.resize(document.getElementById('538b8031-8157-4473-aaab-221d4569c87b'))\n",
-       "})\n",
-       " }) \n",
-       "</script>"
-      ],
-      "text/plain": [
-       "#<Plotly::Offline::HTML:0x007ff4ac144a30 @id=\"538b8031-8157-4473-aaab-221d4569c87b\", @data=[{:z=>[[1, 20, 30], [20, 1, 60], [30, 60, 1]], :type=>:heatmap}], @layout={}, @config={:linkText=>\"Export to plot.ly\", :showLink=>true}, @embedded=true>"
-      ]
-     },
-     "metadata": {},
-     "output_type": "display_data"
-    }
-   ],
-   "source": [
-    "# Basic Heatmap\n",
-    "require 'rbplotly'\n",
-    "\n",
-    "z = [\n",
-    "  [1, 20, 30],\n",
-    "  [20, 1, 60],\n",
-    "  [30, 60, 1]\n",
-    "]\n",
-    "\n",
-    "data = [{\n",
-    "  z: z,\n",
-    "  type: :heatmap\n",
-    "}]\n",
-    "\n",
-    "plot = Plotly::Plot.new(data: data)\n",
-    "plot.show"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 2,
-   "metadata": {
-    "collapsed": false
-   },
-   "outputs": [
-    {
-     "data": {
-      "text/html": [
-       "\n",
-       "  <script>\n",
-       "  requirejs.config({paths: { 'plotly': ['https://cdn.plot.ly/plotly-latest.min'] }})\n",
-       "  </script>\n",
-       "\n",
-       "\n",
-       "<div id=\"30fe907e-b3ae-4b61-ae76-e40bd75080c4\" style=\"height: 100%; width: 100%;\"></div>\n",
-       "\n",
-       "<script>\n",
-       " require(['plotly'], function(Plotly) { \n",
-       "Plotly.newPlot(\n",
-       "  '30fe907e-b3ae-4b61-ae76-e40bd75080c4',\n",
-       "  [{\"z\":[[0,6,5,5,3,9,6,6,9,7],[6,3,2,5,9,1,4,6,7,4],[7,6,8,2,1,0,0,1,3,7],[6,8,8,4,3,1,0,8,5,3],[1,2,4,0,2,6,4,2,7,6],[3,2,9,6,2,7,5,6,1,5],[2,0,3,4,4,8,6,9,2,9],[3,5,0,6,7,0,8,6,6,0],[0,8,3,9,7,6,5,0,9,9],[6,4,3,5,2,8,2,8,6,8]],\"type\":\"heatmap\",\"x\":[\"x1\",\"x2\",\"x3\",\"x4\",\"x5\",\"x6\",\"x7\",\"x8\",\"x9\",\"x10\"],\"y\":[\"y1\",\"y2\",\"y3\",\"y4\",\"y5\",\"y6\",\"y7\",\"y8\",\"y9\",\"y10\"]}],\n",
-       "  {\"width\":500,\"height\":500},\n",
-       "  {\"linkText\":\"Export to plot.ly\",\"showLink\":true}\n",
-       ")\n",
-       "\n",
-       "window.addEventListener('resize', function() {\n",
-       "  Plotly.Plots.resize(document.getElementById('30fe907e-b3ae-4b61-ae76-e40bd75080c4'))\n",
-       "})\n",
-       " }) \n",
-       "</script>"
-      ],
-      "text/plain": [
-       "#<Plotly::Offline::HTML:0x007ff4ac82e0d0 @id=\"30fe907e-b3ae-4b61-ae76-e40bd75080c4\", @data=[{:z=>[[0, 6, 5, 5, 3, 9, 6, 6, 9, 7], [6, 3, 2, 5, 9, 1, 4, 6, 7, 4], [7, 6, 8, 2, 1, 0, 0, 1, 3, 7], [6, 8, 8, 4, 3, 1, 0, 8, 5, 3], [1, 2, 4, 0, 2, 6, 4, 2, 7, 6], [3, 2, 9, 6, 2, 7, 5, 6, 1, 5], [2, 0, 3, 4, 4, 8, 6, 9, 2, 9], [3, 5, 0, 6, 7, 0, 8, 6, 6, 0], [0, 8, 3, 9, 7, 6, 5, 0, 9, 9], [6, 4, 3, 5, 2, 8, 2, 8, 6, 8]], :type=>:heatmap, :x=>[\"x1\", \"x2\", \"x3\", \"x4\", \"x5\", \"x6\", \"x7\", \"x8\", \"x9\", \"x10\"], :y=>[\"y1\", \"y2\", \"y3\", \"y4\", \"y5\", \"y6\", \"y7\", \"y8\", \"y9\", \"y10\"]}], @layout={:width=>500, :height=>500}, @config={:linkText=>\"Export to plot.ly\", :showLink=>true}, @embedded=true>"
-      ]
-     },
-     "metadata": {},
-     "output_type": "display_data"
-    }
-   ],
-   "source": [
-    "require 'rbplotly'\n",
-    "\n",
-    "n = 10\n",
-    "data = {\n",
-    "  x: (1..n).map { |i| \"x#{i}\" },\n",
-    "  y: (1..n).map { |i| \"y#{i}\" },\n",
-    "  z: (1..n).map { (1..n).map { rand(10) } },\n",
-    "  type: :heatmap\n",
-    "}\n",
-    "\n",
-    "layout = {\n",
-    "  width:  500,\n",
-    "  height: 500\n",
-    "}\n",
-    "\n",
-    "plot = Plotly::Plot.new(data: [data], layout: layout)\n",
-    "plot.show"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {
-    "collapsed": true
-   },
-   "outputs": [],
-   "source": []
-  }
- ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "Ruby 2.3.1",
-   "language": "ruby",
-   "name": "ruby"
-  },
-  "language_info": {
-   "file_extension": ".rb",
-   "mimetype": "application/x-ruby",
-   "name": "ruby",
-   "version": "2.3.1"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 1
-}

data/lib/plotly/axis.rb

@@ -1,18 +0,0 @@
-require 'plotly/castable'
-
-module Plotly
-  class Axis
-    include Castable
-
-    ATTRS = %i(title range zeroline).freeze
-    attr_accessor(*ATTRS)
-
-    # @option opts [String] title
-    # @option opts [Array] range
-    # @option opts [Boolean] zeroline
-    def initialize(opts)
-      return unless opts.is_a?(Hash)
-      opts.each { |k, v| instance_variable_set("@#{k}", v) }
-    end
-  end
-end

data/lib/plotly/castable.rb

@@ -1,20 +0,0 @@
-module Plotly
-  module Castable
-    def to_h
-      instance_variables.map do |attribute|
-        k = attribute.to_s.delete('@').to_sym
-        v = instance_variable_get(attribute)
-
-        v = v.to_h if in_plotly_module?(v.class)
-
-        [k, v]
-      end.to_h
-    end
-
-    private
-
-    def in_plotly_module?(klazz)
-      klazz.to_s.split('::').first == 'Plotly'
-    end
-  end
-end

data/lib/plotly/client.rb

@@ -1,45 +0,0 @@
-require 'faraday'
-require 'base64'
-require 'json'
-
-module Plotly
-  class Client
-    attr_reader :conn
-
-    # @param username [String]
-    # @param api_key [String]
-    def initialize(username, api_key)
-      @conn = Faraday.new(
-        url: 'https://api.plot.ly/v2',
-        headers: build_headers(username, api_key)
-      )
-    end
-
-    private
-
-    # @param username [String]
-    # @param api_key [String]
-    # @return [Hash] HTTP headers
-    def build_headers(username, api_key)
-      encoded_auth = Base64.encode64("#{username}:#{api_key}")
-      {
-        'plotly-client-platform' => "Ruby #{Plotly::VERSION}",
-        'content-type' => 'application/json',
-        authorization: "Basic #{encoded_auth}"
-      }
-    end
-  end
-
-  class << self
-    # Set the default client which is automatically used when any clients aren't assigned.
-    def auth(username, api_key)
-      @client = Client.new(username, api_key)
-    end
-
-    # @return [Plotly::Client]
-    # @raise [RuntimeError]
-    def client
-      @client ? @client : raise('Authentication required')
-    end
-  end
-end

data/lib/plotly/data.rb

@@ -1,33 +0,0 @@
-require 'plotly/castable'
-require 'plotly/marker'
-
-module Plotly
-  class Data
-    include Castable
-
-    attr_accessor :x, :y, :z, :values, :labels, :mode, :type, :name, :text, :colorscale, :marker
-
-    # @option opts [Array] x
-    # @option opts [Array] y
-    # @option opts [Array] z
-    # @option opts [Array] values
-    # @option opts [Array] labels
-    # @option opts [String] mode
-    # @option opts [String] type
-    # @option opts [String] name
-    # @option opts [Array] text array of strings
-    # @option opts [Array] colorscale
-    # @option opts [Hash or Plotly::Marker] marker
-    def initialize(opts = {})
-      opts.each do |k, v|
-        v.convert_to(Plotly::Marker) if k == marker
-        instance_variable_set("@#{k}", v)
-      end
-    end
-
-    def marker=(marker)
-      marker.convert_to(Plotly::Marker)
-      @marker = marker
-    end
-  end
-end

data/lib/plotly/exportable.rb

@@ -1,23 +0,0 @@
-module Plotly
-  module Exportable
-    # @option format [String]
-    # @option path [String]
-    # @option width [FIxnum]
-    # @option height [FIxnum]
-    # @option scale [FIxnum]
-    # @option client [Plotly::Client]
-    def download_image(format: :png, path: 'plot.png', client: ::Plotly.client,
-                       width: nil, height: nil, scale: nil)
-      payload = {
-        figure: { data: @data.map(&:to_h), layout: @layout.to_h },
-        format: format
-      }
-      payload[:height] = height unless height.nil?
-      payload[:width]  = width  unless width.nil?
-      payload[:scale]  = scale  unless scale.nil?
-
-      res = client.conn.post('images', payload.to_json)
-      IO.binwrite(path, res.body)
-    end
-  end
-end

data/lib/plotly/layout.rb

@@ -1,33 +0,0 @@
-require 'plotly/castable'
-require 'plotly/axis'
-
-module Plotly
-  class Layout
-    include Castable
-
-    ATTRS = %i(title barmode xaxis yaxis width height).freeze
-    attr_accessor(*ATTRS)
-
-    AXISES = %i(xaxis yaxis).freeze
-
-    # @option opts [String] title
-    # @option opts [String] barmode
-    # @option opts [Hash] xaxis
-    # @option opts [Hash] yaxis
-    def initialize(opts = {})
-      return unless opts.is_a?(Hash)
-
-      opts.each do |k, v|
-        v.convert_to(Plotly::Axis) if AXISES.include?(k)
-        instance_variable_set("@#{k}", v)
-      end
-    end
-
-    AXISES.each do |axis_name|
-      define_method("#{axis_name}=") do |axis|
-        axis.convert_to(Plotly::Axis)
-        instance_variable_set("@#{axis_name}", axis)
-      end
-    end
-  end
-end

data/lib/plotly/line.rb

@@ -1,17 +0,0 @@
-require 'plotly/castable'
-
-module Plotly
-  class Line
-    include Castable
-
-    ATTRS = %i(width color).freeze
-    attr_accessor(*ATTRS)
-
-    # @option opts [Fixnum] width
-    # @option opts [String] color 'rgba(0, 0, 200, .5)'
-    def initialize(opts)
-      return unless opts.is_a?(Hash)
-      opts.each { |k, v| instance_variable_set("@#{k}", v) }
-    end
-  end
-end

data/lib/plotly/marker.rb

@@ -1,23 +0,0 @@
-require 'plotly/castable'
-require 'plotly/line'
-
-module Plotly
-  class Marker
-    include Castable
-
-    ATTRS = %i(size color opacity line).freeze
-    attr_accessor(*ATTRS)
-
-    # @option opts [Fixnum] size
-    # @option opts [String] color e.g.'rgba(0, 0, 200, .5)'
-    # @option opts [Hash or Plotly::Line] line
-    def initialize(opts)
-      return unless opts.is_a?(Hash)
-
-      opts.each do |k, v|
-        v.convert_to(Plotly::Line) if k.to_sym == :line
-        instance_variable_set("@#{k}", v)
-      end
-    end
-  end
-end

data/lib/plotly/offline/exportable.rb

@@ -1,36 +0,0 @@
-require 'uuidtools'
-require 'launchy'
-require 'plotly/offline/html'
-
-module Plotly
-  module Offline
-    module Exportable
-      # for IRuby
-      def show
-        # @todo unless defined? IRuby
-        html = create_html(@data, layout: @layout, embedded: true)
-        IRuby.display(html)
-      end
-
-      # @param path [String]
-      # @param open [Boolean]
-      def generate_html(path: 'plot.html', open: true)
-        html = create_html(@data, layout: @layout)
-        File.write(path, html.render)
-        Launchy.open(File.absolute_path(path)) if open
-      end
-
-      def to_html
-        html = create_html(@data, layout: @layout, embedded: true)
-        html.render
-      end
-
-      private
-
-      def create_html(data, layout: {}, embedded: false)
-        id = UUIDTools::UUID.random_create.to_s
-        HTML.new(id, data.map(&:to_h), layout: layout.to_h, embedded: embedded)
-      end
-    end
-  end
-end

data/lib/plotly/offline/html.rb

@@ -1,46 +0,0 @@
-require 'erb'
-require 'json'
-
-module Plotly
-  module Offline
-    class HTML
-      DEFAULT_CONFIG    = { linkText: 'Export to plot.ly', showLink: true }.freeze
-      PLOTLY_JS_CDN_URL = 'https://cdn.plot.ly/plotly-latest.min'.freeze
-      LOCAL_PLOTLY_JS   = File.read(File.expand_path('../plotly.min.js', __FILE__))
-
-      # @param id [String]
-      # @param data [Array]
-      # @option layout [Hash]
-      # @option config [Hash]
-      # @option embedded [Boolean]
-      def initialize(id, data, layout: {}, config: DEFAULT_CONFIG, embedded: false)
-        @id       = id
-        @data     = data
-        @layout   = layout
-        @config   = config
-        @embedded = embedded
-      end
-
-      # @return [String] HTML document
-      def render
-        template_name = @embedded ? :body : :plot
-        template = template_for(template_name)
-        erb = ERB.new(template)
-        erb.result(binding)
-      end
-
-      # This method is used to embed plots into IRuby notebooks.
-      # @return [Array]
-      def to_iruby
-        ['text/html', render]
-      end
-
-      private
-
-      def template_for(name)
-        template_path = File.expand_path("../templates/#{name}.erb", __FILE__)
-        File.read(template_path)
-      end
-    end
-  end
-end