https://github.com/zuhao/plotrb

A plotting library in Ruby built on top of Vega and D3.
https://github.com/zuhao/plotrb

Last synced: 3 months ago
JSON representation

A plotting library in Ruby built on top of Vega and D3.

• Host: GitHub
• URL: https://github.com/zuhao/plotrb
• Owner: zuhao
• License: other
• Created: 2013-06-15T16:37:25.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2013-09-23T05:10:48.000Z (about 11 years ago)
• Last Synced: 2024-05-13T13:34:07.436Z (6 months ago)
• Language: Ruby
• Homepage:
• Size: 644 KB
• Stars: 41
• Watchers: 6
• Forks: 12
• Open Issues: 3
• Metadata Files:
  • Readme: README.rdoc
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
= Plotrb

Vega/D3-based plotting gem for Ruby

* {sciruby.com}[http://sciruby.com]

* {Google+}[https://plus.google.com/109304769076178160953/posts]

* {Wan Zuhao}[http://www.wanzuhao.com]

* {Examples on bl.ocks.org}[http://bl.ocks.org/zuhao]

{}[https://travis-ci.org/zuhao/plotrb]

== Description

Plotrb is an experimental plotting library for the Ruby language. It

brings {the simplicity of Vega}[http://trifacta.github.io/vega/] and

{the power of D3}[http://d3js.org/] to the Ruby science community, to

allow for {fast, customizable design; reusability and shareability; programmatic generation of visualizations; and improved performance and platform flexibility}[https://github.com/trifacta/vega/wiki/Vega-and-D3].

Plotrb is in many ways the child of

{Rubyvis}[http://github.com/SciRuby/rubyvis] (the Ruby port of

Protovis). However, it improves upon Rubyvis in that it uses a DSL that

will be much more familiar and natural to Ruby coders.

Plotrb was created by Wan Zuhao as part of Google's Summer of Code 2013.

It is part of {SciRuby}[http://sciruby.com].

== Installation

Add this line to your application's Gemfile:

    gem 'plotrb'

And then execute:

    bundle

Or install it yourself as:

    gem install plotrb

== Usage

Currently, Plotrb is intended to generate JSON specification for Vega. If you would like to see the visualization rendered in PNG or SVG, you will have to install {Vega}[https://github.com/trifacta/vega] and use its {Headless Mode}[https://github.com/trifacta/vega/wiki/Headless-Mode].

Note that Plotrb is a work in progress, so we can't guarantee that every

example will work exactly.

* {Arc}[http://bl.ocks.org/zuhao/6663966]

* {Area}[http://bl.ocks.org/zuhao/6663999]

* {Bar}[http://bl.ocks.org/zuhao/6662333]

* {Barley}[http://bl.ocks.org/zuhao/6664828]

* {Lifelines}[http://bl.ocks.org/zuhao/6664107]

Examples may also be found in the `examples/` directory.

== 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

== License

Copyright (c) 2013, Wan Zuhao and the Ruby Science Foundation.

All rights reserved.

Plotrb, along with SciRuby, is licensed under the BSD 2-clause license. See

{LICENSE.txt}[https://github.com/SciRuby/sciruby/wiki/License] for details.

== Donations

Support a SciRuby Fellow:

{}[http://www.pledgie.com/campaigns/15783]