README.md in iruby-chartkick-0.2.1 vs README.md in iruby-chartkick-0.3.0
- old
+ new
@@ -1,8 +1,8 @@
-# iruby-chartkick [](https://travis-ci.com/Absolventa/iruby-chartkick)
+# iruby-chartkick [](https://github.com/Absolventa/iruby-chartkick/actions/workflows/build.yml)
-You like writing [Ruby within Juypter](https://github.com/SciRuby/iruby/) notebooks? Awesome, you're not alone - we do so, too ☀️ Since we also fell in love with the handy charting API of [ankane/chartkick](https://github.com/ankane/chartkick), we wrote this little gem bringing them together.
+You like writing [Ruby within Juypter](https://github.com/SciRuby/iruby/) notebooks? Awesome, you're not alone - we do so, too ☀️ Since we also fell in love with the handy charting API of [ankane/chartkick](https://github.com/ankane/chartkick), we wrote this little gem bringing them together.
`iruby-chartkick` was made for easy plug-n-play plotting data using the awesomeness of chartkick within IRuby-backed Jupyter notebooks.
### Installation
@@ -10,11 +10,11 @@
### Usage
You can either include the module `IRuby::Chartkick` and use the wrapper methods, like `line_chart`:
-```Ruby
+```ruby
include IRuby::Chartkick
data = {
2019 => 1,
2020 => 122,
@@ -24,11 +24,11 @@
line_chart(data)
```
Or you use the chart wrapper classes directly:
-```Ruby
+```ruby
include IRuby::Chartkick
data = {
2019 => 1,
2020 => 122,
@@ -38,16 +38,99 @@
IRuby::Chartkick::LineChart.new(data).plot
```
### Examples:
+```ruby
+include IRuby::Chartkick
-
-
-
-
-
-
-
-
-
-
+data = [
+ {
+ name: "Monkeys",
+ data: {
+ 2010 => 20,
+ 2011 => 190,
+ 2012 => 188,
+ 2013 => 230,
+ 2014 => 422,
+ 2015 => 56,
+ 2016 => 299,
+ 2019 => 100
+ }
+ },
+ {
+ name: "Pirates",
+ data: {
+ 2010 => 20,
+ 2011 => 90,
+ 2012 => 488,
+ 2013 => 430,
+ 2014 => 122,
+ 2015 => 6,
+ 2016 => 399,
+ 2019 => 500
+ }
+ }
+]
+```
+
+#### LineChart
+
+```ruby
+line_chart(data)
+```
+
+
+```ruby
+line_chart(data, points: false)
+```
+
+
+```ruby
+line_chart(data, points: false, width: "700px", min: 50, max: 300)
+```
+
+
+#### AreaChart
+
+```ruby
+area_chart(data)
+```
+
+
+#### ColumnChart
+
+```ruby
+column_chart(data)
+```
+
+
+#### BarChart
+
+```ruby
+bar_chart(data)
+```
+
+
+#### ScatterChart
+
+```ruby
+scatter_chart(data)
+```
+
+
+#### PieChart
+
+```ruby
+include IRuby::Chartkick
+
+data = [
+ ["Blueberry", 44],
+ ["Strawberry", 23],
+ ["Banana", 22],
+ ["Apple", 21],
+ ["Grape", 13]
+]
+
+pie_chart(data)
+```
+