wilson_score 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: be14e070c2299eb4ca4bfb98fff17bc037778702
-  data.tar.gz: 811d3aed20e01c0f4498c5ef40ac7129f8322eff
+  metadata.gz: 5d7bb501c73ead396229401fe42913d871b40415
+  data.tar.gz: 28ec167d67257eddf27488f0372fe26374e54f90
 SHA512:
-  metadata.gz: 640f472abf05bd6f9acc79ee4644136387346a15d409c60d4c0dd5f739da5aaef2e4178bcf79d954822c5e4477676c577eaccde796b8b76f37ea5ade87440925
-  data.tar.gz: ee62a52fc1f1049a4c3c2659afa4621fd651ed2b923c16b4c4d26fea556f753b286e2466f3446d2a7b02c8e459284a8ac6e5f7c1b6c58ec25132d3d3fb2be74a
+  metadata.gz: a7df05093b79ad6080ec347db2f93aaca8f6cccb982dfabc7492e5c90dea6a8cd5c172731ff14c437224389eb82a2e61915a4a87cf3dd57b8911932c3f3ec8f7
+  data.tar.gz: b34ed9eec15dea13d48f523d91d5e4db1af62cdae38cf417f6dba92c971d4b673e6702decf21c56427e6206fa329b1f65daf7949b08f4b81fa15c09809980c3b

data/README.md

@@ -9,13 +9,25 @@ Inspired by [How Not To Sort By Average Rating](http://www.evanmiller.org/how-no
 3 positive ratings out of 5 with 95% confidence
 
 ```ruby
-WilsonScore.interval(3, 5, 0.95)
+WilsonScore.lower_bound(3, 5)
 ```
 
-[Continuity correction](http://en.wikipedia.org/wiki/Binomial_proportion_confidence_interval#Wilson_score_interval_with_continuity_correction) can improve the score, especially for a small number of samples (n < 30).  Set the last paramter to true to use it.
+[Continuity correction](http://en.wikipedia.org/wiki/Binomial_proportion_confidence_interval#Wilson_score_interval_with_continuity_correction) can improve the score, especially for a small number of samples (n < 30).  As of version 0.1.0, it is enabled by default.  To disable continuity correction, use:
 
 ```ruby
-WilsonScore.interval(3, 5, 0.95, true)
+WilsonScore.lower_bound(3, 5, correction: false)
+```
+
+The default confidence level is 95%. To change this, use:
+
+```ruby
+WilsonScore.lower_bound(3, 5, confidence: 0.99)
+```
+
+To get the full interval, use:
+
+```ruby
+WilsonScore.interval(3, 5)
 ```
 
 ## Star Ratings
@@ -28,16 +40,10 @@ A product has two ratings - one 4 star and one 5 star.
 average_rating = 4.5
 total_ratings = 2
 rating_range = 1..5  # 1 to 5 stars
-confidence = 0.95    # 95%
 
-interval = WilsonScore.rating_interval(average_rating, total_ratings, rating_range, confidence)
-lower_bound = interval.first
+WilsonScore.rating_lower_bound(average_rating, total_ratings, rating_range)
 ```
 
-Use the lower bound of the interval to sort items.
-
-Again, you can set the last parameter to `true` for continuity correction.
-
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/wilson_score.rb

@@ -3,7 +3,12 @@ require "wilson_score/version"
 module WilsonScore
 
   # http://en.wikipedia.org/wiki/Binomial_proportion_confidence_interval
-  def self.interval(k, n, confidence, correction = false)
+  def self.interval(k, n, *args)
+    args = args.dup
+    options = args[-1].is_a?(Hash) ? args.pop : {}
+    confidence = args[0] || options[:confidence] || 0.95
+    correction = !args[1].nil? ? args[1] : (options.has_key?(:correction) ? options[:correction] : true)
+
     z = pnorm(1 - (1 - confidence) / 2.0)
     phat = k / n.to_f
     z2 = z**2
@@ -12,10 +17,9 @@ module WilsonScore
       b = 2*n*phat + z2
       c = z * Math.sqrt(z2 - 1.0/n + 4*n*phat*(1 - phat) + (4*phat - 2)) + 1
       d = z * Math.sqrt(z2 - 1.0/n + 4*n*phat*(1 - phat) - (4*phat - 2)) + 1
-      # hack for phat = 0 or 1
-      lower = phat == 0 ? 0 : (b - c) / a
-      upper = phat == 1 ? 1 : (b + d) / a
-      ([0, lower].max)..([1, upper].min)
+      lower = phat == 0 ? 0 : [0, (b - c) / a].max
+      upper = phat == 1 ? 1 : [1, (b + d) / a].min
+      lower..upper
     else
       a = 1 + z2 / n
       b = phat + z2 / (2 * n)
@@ -24,7 +28,16 @@ module WilsonScore
     end
   end
 
-  def self.rating_interval(avg, n, score_range, confidence, correction = false)
+  def self.lower_bound(k, n, options = {})
+    interval(k, n, options).first
+  end
+
+  def self.rating_interval(avg, n, score_range, *args)
+    args = args.dup
+    options = args[-1].is_a?(Hash) ? args.pop : {}
+    confidence = args[0] || options[:confidence] || 0.95
+    correction = !args[1].nil? ? args[1] : (options.has_key?(:correction) ? options[:correction] : true)
+
     min = score_range.first
     max = score_range.last
     range = max - min
@@ -32,6 +45,10 @@ module WilsonScore
     (min + range * interval.first)..(min + range * interval.last)
   end
 
+  def self.rating_lower_bound(avg, n, score_range, options = {})
+    rating_interval(avg, n, score_range, options).first
+  end
+
   protected
 
   # from the statistics2 gem

data/lib/wilson_score/version.rb

@@ -1,3 +1,3 @@
 module WilsonScore
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/test/wilson_score_test.rb

@@ -3,51 +3,71 @@ require_relative "test_helper"
 class TestWilsonScore < Minitest::Test
 
   def test_wilson_score
-    interval = WilsonScore.interval(1, 2, 0.95)
+    interval = WilsonScore.interval(1, 2, correction: false)
     assert_in_delta 0.0945, interval.first
     assert_in_delta 0.9055, interval.last
   end
 
+  def test_lower_bound
+    assert_in_delta 0.0267, WilsonScore.lower_bound(1, 2)
+  end
+
   def test_continuity_correction
-    interval = WilsonScore.interval(1, 2, 0.95, true)
+    interval = WilsonScore.interval(1, 2)
     assert_in_delta 0.0267, interval.first
     assert_in_delta 0.9733, interval.last
   end
 
   def test_continuity_correction_zero_one
-    interval = WilsonScore.interval(0, 1, 0.95, true)
+    interval = WilsonScore.interval(0, 1)
     assert_in_delta 0, interval.first
     assert_in_delta 0.9454, interval.last
   end
 
+  def test_continuity_correction_zero_ten
+    interval = WilsonScore.interval(0, 10)
+    assert_in_delta 0, interval.first
+    assert_in_delta 0.3445, interval.last
+  end
+
+  def test_continuity_correction_one_ten
+    interval = WilsonScore.interval(1, 10)
+    assert_in_delta 0.0052, interval.first
+    assert_in_delta 0.4588, interval.last
+  end
+
   def test_continuity_correction_one_fifty
-    interval = WilsonScore.interval(1, 50, 0.95, true)
+    interval = WilsonScore.interval(1, 50)
     assert_in_delta 0.0010, interval.first
     assert_in_delta 0.1201, interval.last
   end
 
   def test_continuity_correction_one_one
-    interval = WilsonScore.interval(1, 1, 0.95, true)
+    interval = WilsonScore.interval(1, 1)
     assert_in_delta 0.0546, interval.first
     assert_in_delta 1, interval.last
   end
 
   def test_continuity_correction_one_three
-    interval = WilsonScore.interval(1, 3, 0.95, true)
+    interval = WilsonScore.interval(1, 3)
     assert_in_delta 0.0176, interval.first
     assert_in_delta 0.8747, interval.last
   end
 
   def test_rating
-    interval = WilsonScore.rating_interval(5, 1, 1..5, 0.95)
+    interval = WilsonScore.rating_interval(5, 1, 1..5, correction: false)
     assert_in_delta 1.8262, interval.first
     assert_in_delta 5, interval.last
   end
 
   def test_rating_advanced
-    interval = WilsonScore.rating_interval(3.7, 10, 1..5, 0.95)
+    interval = WilsonScore.rating_interval(3.7, 10, 1..5, correction: false)
     assert_in_delta 2.4998, interval.first
     assert_in_delta 4.5117, interval.last
   end
 
+  def test_rating_lower_bound
+    assert_in_delta 1.8262, WilsonScore.rating_lower_bound(5, 1, 1..5, correction: false)
+  end
+
 end

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: wilson_score
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-05 00:00:00.000000000 Z
+date: 2014-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Simple, dependency-free Wilson score
@@ -59,7 +59,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -79,17 +79,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.0
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: Simple, dependency-free Wilson score