rails-data-explorer 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 111102a24d7fb013d746b9a0dba6df3f7a881c1d
-  data.tar.gz: a2a99dd6d1b00c8f62143c725fdb7eb0bd6bb404
+  metadata.gz: 3c75cb60d7ecddbc2fb8e07eb44d25b959b20ba3
+  data.tar.gz: cfdfa4cfa4e253190a32a7ee35d13538158e1a93
 SHA512:
-  metadata.gz: 75fd9d7a12c1e32bc06fad41a4e662165aed8909290bf5c7fd17270a9d4e7dd23d780c5611bf42bd835d0052648cf17e3aa6a07f70e0b899bcf58772b7a9ea3c
-  data.tar.gz: c5c5236cb2fbcb441be1a4a449b405f02ec06741880bedeeb1cd5e9bdcb74fbdc774da84baaccf2a12b932ebbc1b272405f4bdec51203333e6f3d5d49285642c
+  metadata.gz: 1c030c17f16b5f3a421015a4efe29c3d314cbc087f9defe62d9460245fd19332051f754af3ccfea9dfcffb781110444bf5e104a183c8021dc7b4ab90cac235ad
+  data.tar.gz: de5468fd6bd0136f96ba11e7a03f7879cffbcad0b78d4c343cc7cca6b9227827623aa461366ebab7868e6e5ec52b076112c1b5d99ed8237874d893827583cc32

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+### 0.2.1
+
+* Fixed a bug
+* Updated documentation
+
 ## 0.2.0
 
 * Improvements to charts.

data/README.md

@@ -1,16 +1,15 @@
-rails-data-explorer
-===================
+# rails-data-explorer
 
-rails-data-explorer is a Rails Engine plugin that makes it easy to explore the
+Rails-data-explorer is a Rails Engine plugin that makes it easy to explore the
 data in your app using charts and statistics.
 
-Make sure to go to the thorough [documentation](http://rails-data-explorer.clearcove.ca)
-to find out more!
+All you have to do is to throw your data in table form at rails-data-explorer.
+Rails-data-explorer then analyzes your data and automatically renders suitable
+charts and descriptive statistics for each column. It offers tools for uni-, bi-
+and multi-variate analysis. It can even find correlations in your categorical data
+using Pearson's Chi Squared test.
 
-## IMPORTANT NOTE
-
-This gem is under active development and will see significant changes until it's
-officially released.
+See below for a screenshot of what you get.
 
 ### Installation
 
@@ -21,38 +20,105 @@ or with bundler in your Gemfile:
 `gem 'rails-data-explorer'`
 
 
-### Concepts
-
-* Exploration - top level container
-* DataSet - like a spreadsheet with one or more columns of data
-* DataSeries - like a column in a spreadsheet, with multiple rows of data
-* DataType - Each DataSeries contains data of a certain type.
-    * Categorical
-    * Quantitative
-        * Integer
-        * Decimal
-        * Temporal
-    * Geo
-* Chart -
+### Usage
+
+Let's say you want to explore your app's `User` signup data. Create a route and action
+named 'signups' in `app/controllers/users_controller.rb`:
+
+~~~ ruby
+def signups
+  user_data = User.all.to_a
+  c_binner = RailsDataExplorer::Utils::DataBinner.new(
+    '0' => 0,
+    '1' => 1,
+    '2' => 2,
+    '3..10' => 10,
+    '11..100' => 100,
+    '101..1,000' => 1000,
+    '1,001..10,000' => 10000
+  )
+  @rails_data_explorer = RailsDataExplorer.new(
+    user_data,
+    [
+      {
+        name: "Session duration [Minutes]",
+        data_method: Proc.new { |row|
+          ((row.session_duration_minutes * 100).round)/100.0
+        },
+      },
+      {
+        name: "Country",
+        data_method: Proc.new { |row| row.country },
+        multivariate: ['All'],
+      },
+      {
+        name: "Sign in count",
+        data_method: Proc.new { |row| c_binner.bin(row.sign_in_count) },
+      },
+      {
+        name: "Language",
+        data_method: Proc.new { |row| row.language },
+        multivariate: ['All'],
+      },
+      {
+        name: "Plan",
+        data_method: Proc.new { |row| row.plan },
+        multivariate: ['All'],
+      },
+      {
+        name: "Sign up date",
+        data_method: Proc.new { |row| row.created_at },
+      },
+      {
+        name: "Sign up quarter",
+        data_method: Proc.new { |row|
+          year = row.created_at.year
+          quarter = (row.created_at.month / 3.0).ceil
+          "#{ year } / Q#{ quarter }"
+        },
+      },
+    ]
+  )
+end
+~~~
+
+Then create a view at `app/views/users/signups.html.erb`:
+
+~~~erb
+<div class="rails-data-explorer">
+  <h1>User signup data</h1>
+  <%= @rails_data_explorer.render %>
+</div>
+~~~
+
+With just a few lines of code you get comprehensive statistics and charts for your data:
+
+***
+
+![Rails data exploration](https://github.com/jhund/rails-data-explorer/blob/master/doc/rails-data-explorer-screenshot.png)
+
+***
 
 
 ### Ways to shoot yourself in the foot
 
-* Loading too many DB rows at once: Remember that you are loading ActiveRecord
+* **Loading too many DB rows at once**: Remember that you are loading ActiveRecord
   objects, and they can use a lot of ram. It's a cartesian product of number of
   rows times columns per record. As a rule of thumb, for a medium sized model with
   30 columns, you can load up to 10,000 rows.
-* Using expensive operations in the :data_method option for a given data series.
+* **Using expensive operations in the `:data_method` option for a given data series**:
   As a rule of thumb, it should be ok to run simple methods that don't require
-  DB access. Examples: `#.to_s`, `if` and `case`, and math operations.
-* Declaring too many charts: The charts rendered are the sum of the following:
+  DB access. Examples: `#.to_s`, `if` and `case`, and math operations should all
+  be fine.
+* **Declaring too many charts**: The charts rendered are the sum of the following:
     * univariate: one or more charts for each data series
     * bivariate: the cartesian product of all data series in a bivariate group
     * multivariate: one or more charts for each multivariate group
   I have tested it with 70 charts on a single page. More are probably ok, I
   just haven't tested it.
-* Drowning in detail. rde makes it easy to generate a large number of charts.
-  Make sure you don't miss the important data in the noise.
+* **Drowning in detail**: rails-data-explorer makes it easy to generate a large
+  number of charts. Make sure you don't miss the important data in the noise.
+
 
 ### Dependencies
 
@@ -63,8 +129,6 @@ or with bundler in your Gemfile:
 
 ### Resources
 
-* [Documentation](http://rails-data-explorer.clearcove.ca)
-* [Live demo](http://rails-data-explorer-demo.herokuapp.com)
 * [Changelog](https://github.com/jhund/rails-data-explorer/blob/master/CHANGELOG.md)
 * [Source code (github)](https://github.com/jhund/rails-data-explorer)
 * [Issues](https://github.com/jhund/rails-data-explorer/issues)
@@ -78,4 +142,4 @@ or with bundler in your Gemfile:
 
 ### Copyright
 
-Copyright (c) 2014 Jo Hund. See [(MIT) LICENSE](https://github.com/jhund/rails-data-explorer/blob/master/MIT-LICENSE) for details.
+Copyright (c) 2015 Jo Hund. See [(MIT) LICENSE](https://github.com/jhund/rails-data-explorer/blob/master/MIT-LICENSE) for details.

data/lib/rails-data-explorer/chart/contingency_table.rb

@@ -182,7 +182,7 @@ class RailsDataExplorer
             delta = @observed_vals[x_val][y_val] - @expected_vals[x_val][y_val]
             delta_factor = delta / @expected_vals[x_val][y_val].to_f
             @delta_attrs[x_val][y_val] = {
-              :expected @expected_vals[x_val][y_val],
+              expected: @expected_vals[x_val][y_val],
               color: color_scale.compute(delta_factor),
               delta: delta,
               delta_factor: delta_factor,

data/rails-data-explorer.gemspec

@@ -3,12 +3,12 @@ $:.push File.expand_path('../lib', __FILE__)
 
 Gem::Specification.new do |gem|
   gem.name = 'rails-data-explorer'
-  gem.version = '0.2.0'
+  gem.version = '0.2.1'
   gem.platform = Gem::Platform::RUBY
 
   gem.authors = ['Jo Hund']
   gem.email = 'jhund@clearcove.ca'
-  gem.homepage = 'http://rails-data-explorer.clearcove.ca'
+  gem.homepage = 'https://github.com/jhund/rails-data-explorer'
   gem.licenses = ['MIT']
   gem.summary = 'A Rails engine plugin for exploring data in your app with charts and statistics.'
   gem.description = %(rails-data-explorer is a Rails Engine plugin that makes it easy to explore the data in your app using charts and statistics.)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-data-explorer
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Jo Hund
@@ -165,6 +165,7 @@ files:
 - Rakefile
 - doc/how_to/release.md
 - doc/how_to/trouble_when_packaging_assets.md
+- doc/rails-data-explorer-screenshot.png
 - lib/rails-data-explorer-no-rails.rb
 - lib/rails-data-explorer.rb
 - lib/rails-data-explorer/action_view_extension.rb
@@ -233,7 +234,7 @@ files:
 - vendor/assets/stylesheets/sources/d3.parsets.css
 - vendor/assets/stylesheets/sources/nv.d3.css
 - vendor/assets/stylesheets/sources/rde-default-style.css
-homepage: http://rails-data-explorer.clearcove.ca
+homepage: https://github.com/jhund/rails-data-explorer
 licenses:
 - MIT
 metadata: {}