Permalink
Browse files

Improve the README

  • Loading branch information...
1 parent 0949d20 commit a870570c07d39cea9cdfc8e40c3dc0f6d11580eb @lukec committed Mar 5, 2013
Showing with 55 additions and 6 deletions.
  1. +0 −5 README
  2. +55 −1 README.md
View
5 README
@@ -1,5 +0,0 @@
-This project is some scripts for the Vancouver Rental Issues dataset.
-
- http://data.vancouver.ca/datacatalogue/rentalStandards.htm
-
-These scripts will download, scrape and parse this dataset and related information.
View
@@ -1 +1,55 @@
-Check out http://shopify.github.com/dashing for more information.
+This project is to make a very basic example dashboard using some Vancouver Open Data.
+
+When designing a dashboard, it's important to consider 3 things:
+
+1 What is your Goal?
+2 What is your methodology?
+3 Something else.
+
+The goal of _this_ project is to provide a simple example codebase for other
+dashboards. Using the Dashing framework, we can create exceptionally handsome
+dashboards.
+
+
+This particular dashboard uses the Vancouver Rental Standards data:
+
+ http://data.vancouver.ca/datacatalogue/rentalStandards.htm
+
+After reviewing the data, I brainstormed some of the dashboard widgets that I
+could build using the data I had available. The first step was to shape the
+data into a structure that would be summarized for display in the widgets.
+
+Unfortunately, the JSON file on the open data portal does not include all the
+data we need. So we need to scrape some HTML from a city search tool to get
+the individual rental infractions.
+
+`bin/scrape` - this is used to grab the JSON, and then scrape the HTML form.
+
+The output of `bin/scrape` is `data.json`.
+
+With the data downloaded, we can then convert it into the metrics we want.
+
+We use `bin/parse` to read `data.json` and analyze/sum/count the data into
+`metrics.json`.
+
+Then our Ruby dashboard can read `metrics.json` and show the results on the
+dashboard.
+
+In order to update the data, one would need to run `bin/scrape` then
+`bin/parse`, then re-start the dashing process to read the latest JSON file.
+Obviously you could design this better so that the Ruby process did the
+scraping and parsing periodically, or polled other APIs.
+
+
+
+For future projects, you'll probably need to scrape/parse your data. This
+project is intended as a reference only, it's probably not suitable for
+directly copying. That's okay, none of this is too difficult.
+
+To learn more about the Dashing framework, check out
+
+ http://shopify.github.com/dashing
+
+
+Yours Truly,
+@lukec

0 comments on commit a870570

Please sign in to comment.