Skip to content

ash1day/rbplotly

Repository files navigation

Gem Version Build Status Test Coverage Code Climate

Rbplotly

Rbplotly, a Ruby visualization library, allows you to create interactive plots.

Installation

Add this line to your application's Gemfile:

gem 'rbplotly'

And then execute:

$ bundle

Or install it yourself as:

$ gem install rbplotly

Usage

require 'rbplotly'

x = [0, 1, 2, 3, 4]
trace0 = { x: x, y: [0, 2, 1, 4, 3], type: :scatter, mode: :lines }
trace1 = { x: x, y: [4, 1, 3, 0, 2], type: :scatter, mode: :'markers+lines' }
data = [trace0, trace1] # data must be an array

layout = { width: 500, height: 500 }

plot = Plotly::Plot.new(data: data, layout: layout)

plot.layout.height = 300 # You can assign plot's attributes.

# If your env has web browser
plot.generate_html(path: './line_chart.html')

# If your env does NOT have web browser
#plot.generate_html(path: './line_chart.html', open: false)

Use #download_image if you want to get an image by using Plot.ly API. You can get your API KEY here.

Plotly.auth(<YOUR_USERNAME>, <YOUR_API_KEY>)
plot.download_image(path: './line_chart.png')

Or use #show on IRuby notebooks.

plot.show

Examples

Visit here to see more examples.

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

About RuboCop

We don't use RuboCop.

Thanks

rbplotly is based on plotly/plotly.py, so there are a lot of code coming from it.

License

Copyright (c) 2016 Yoshihiro Ashida. See LICENSE.txt for further details.