README.md

iruby-chartkick

You like writing Ruby within Juypter notebooks? Awesome, you're not alone - we do so, too ☀️ Since we also fell in love with the handy charting API of 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

gem install iruby-chartkick

Usage

You can either include the module IRuby::Chartkick and use the wrapper methods, like line_chart:

include IRuby::Chartkick
		
data = {
  2019 => 1,
  2020 => 122,
  2021 => 34
}
 
line_chart(data)

Or you use the chart wrapper classes directly:

include IRuby::Chartkick
		
data = {
  2019 => 1,
  2020 => 122,
  2021 => 34
}

IRuby::Chartkick::LineChart.new(data).plot

Examples:

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

line_chart(data)

line_chart(data, points: false)

line_chart(data, points: false, width: "700px", min: 50, max: 300)

AreaChart

area_chart(data)

ColumnChart

column_chart(data)

BarChart

bar_chart(data)

ScatterChart

scatter_chart(data)

PieChart

include IRuby::Chartkick

data = [
  ["Blueberry", 44],
  ["Strawberry", 23],
  ["Banana", 22],
  ["Apple", 21],
  ["Grape", 13]
]

pie_chart(data)