Permalink
Browse files

Updated readme

  • Loading branch information...
1 parent 1aa72cc commit bbf56ef32a6bb0fe93bd2bfc4c2f6ce15100e90d @sparkica committed Jan 24, 2013
Showing with 9 additions and 11 deletions.
  1. +9 −11 README.textile
View
20 README.textile
@@ -1,34 +1,32 @@
h1. refine-stats
-A extension for Google Refine to compute elementary statistics.
+A extension for OpenRefine to compute elementary statistics on a column data.
h2. Installation
-Run Google Refine. On the starting page click the "Browse workspace directory" link in the lower left corner. Make a folder called "extensions" within the the window that pops up. Copy the stats folder into the extensions folder. The final path should be:
+Run OpenRefine. On the starting page click the "Browse workspace directory" link in the lower left corner. Make a folder called "extensions" (if it doesn't exist) within the the window that pops up. Copy the refine-stats folder into the extensions folder. The final path should be something like (it may vary depending on the OS):
<pre>
-/PATH/TO/Google/Refine/extensions/stats/...
+/PATH/TO/Google/Refine/extensions/refine-stats/...
</pre>
-Restart Google Refine.
+Restart OpenRefine.
-(Alternatively, you copy the stats folder into the extensions folder of your Google Refine installation, but it may be lost during upgrades.)
+(Alternatively, you copy the stats folder into the extensions folder of your OpenRefine installation, but it may be lost during upgrades.)
h2. Usage
Select "Column statistics" from the drop-down menu of any column header. Statistics will be calculated based on *filtered rows*, so you can facet your dataset in different ways and calculate statistics for each subset.
h2. Build it yourself
-WARNING: THIS IS NOT REALLY TESTED WE WILL ADD BETTER INSTRUCTIONS SOON.
-
-If you modify this extension, you can build by changing into the stats directoy and executing a command such as:
-
-ant -Drefine.dir=/Users/YOU/src/google-refine/main -Dserver.lib.dir=/Users/YOU/src/google-refine/server/lib build
+If you modify this extension, copy it to extensions folder of OpenRefine installation folder and build it using ./refine build
h2. Credits
-refine-stats is a "Newsapps":http://apps.chicagotribune.com/ project. Development by "Joe Germuska":https://github.com/joegermuska and "Christopher Groskopf":https://github.com/bouvard.
+refine-stats is a "Newsapps":http://apps.chicagotribune.com/ project. Development by "Joe Germuska":https://github.com/joegermuska and "Christopher Groskopf":https://github.com/bouvard.
+
+"Mateja Verlič (sparkica)":https://github.com/sparkica updated it to use newer version of "Apache Commons Math" library and made it work in OpenRefine 2.6 (previously known as Google Refine).
h2. License

0 comments on commit bbf56ef

Please sign in to comment.