wilson_score 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7a66381f037f35b8c6af86cd5c654f243378f620
+  data.tar.gz: 8d56f3a99766730ee9baecbb0c63b39be703fd0b
+SHA512:
+  metadata.gz: 50d652c3613f6bba4dd2c685ad8c60943eb8d974276be0cee64c6fb2fab9aee514efb6b64471d9d862d527853d7d6f3cfdcc61a99aa84b376e654e3c5c6fc20f
+  data.tar.gz: 1734379e9da77cef40f164ba86525f98f35c991f0c3ff954e93ec82b459865a42eb5384b92289e7d8db56e618e3e6d974560f7952515f51cc29cfa0567d07199

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in wilson_score.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Andrew Kane
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,64 @@
+# Wilson Score
+
+Simple, dependency-free [Wilson score](http://en.wikipedia.org/wiki/Binomial_proportion_confidence_interval#Wilson_score_interval)
+
+Inspired by [How Not To Sort By Average Rating](http://www.evanmiller.org/how-not-to-sort-by-average-rating.html) by Evan Miller
+
+## How to Use
+
+3 positive ratings out of 5 with 95% confidence
+
+```ruby
+WilsonScore.interval(3, 5, 0.95)
+```
+
+[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.
+
+```ruby
+WilsonScore.interval(3, 5, 0.95, true)
+```
+
+## Star Ratings
+
+Imagine you have a rating system with 1 to 5 stars.
+
+There are two ratings, a 4 star and a 5 star.
+
+```ruby
+average_rating = 4.5
+total_ratings = 2
+rating_range = 1..5  # 1 to 5 stars
+confidence = 0.95    # 95%
+
+WilsonScore.rating_interval(average_rating, total_ratings, rating_range, confidence)
+```
+
+Again, you can set the last parameter to `true` for continuity correction.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'wilson_score'
+```
+
+And then execute:
+
+```sh
+bundle
+```
+
+## Additional Resources
+
+- http://www.vassarstats.net/prop1.html
+- http://www.goproblems.com/test/wilson/wilson.php
+
+## Contributing
+
+Everyone is encouraged to help improve this project. Here are a few ways you can help:
+
+- [Report bugs](https://github.com/instacart/wilson_score/issues)
+- Fix bugs and [submit pull requests](https://github.com/instacart/wilson_score/pulls)
+- Write, clarify, or fix documentation
+- Suggest or add new features

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+task :default => :test
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+end
+

data/lib/wilson_score/version.rb

@@ -0,0 +1,3 @@
+module WilsonScore
+  VERSION = "0.0.1"
+end

data/lib/wilson_score.rb

@@ -0,0 +1,59 @@
+require "wilson_score/version"
+
+module WilsonScore
+
+  # http://en.wikipedia.org/wiki/Binomial_proportion_confidence_interval
+  def self.interval(k, n, confidence, correction = false)
+    z = pnorm(1 - (1 - confidence) / 2)
+    phat = k / n.to_f
+    if correction # continuity correction
+      a = 1.0 / (2 * (n + z**2))
+      b = 2*n*phat + z**2
+      c = z * Math.sqrt(z**2 - 1.0/n + 4*n*phat*(1 - phat) + (4*phat - 2)) + 1
+      ([0, a * (b - c)].max)..([1, a * (b + c)].min)
+    else
+      a = 1.0 / (1 + z ** 2 / n)
+      b = phat + z ** 2 / (2 * n)
+      c = z * Math.sqrt((phat * (1 - phat) + z ** 2 / (4 * n)) / n)
+      (a * (b - c))..(a * (b + c))
+    end
+  end
+
+  def self.rating_interval(avg, n, score_range, confidence, correction = false)
+    min = score_range.first
+    max = score_range.last
+    range = max - min
+    interval = interval(n * (avg - min) / range, n, confidence, correction)
+    (min + range * interval.first)..(min + range * interval.last)
+  end
+
+  protected
+
+  # from the statistics2 gem
+  # https://github.com/abscondment/statistics2/blob/master/lib/statistics2/base.rb
+  # inverse of normal distribution ([2])
+  # Pr( (-\infty, x] ) = qn -> x
+  def self.pnorm(qn)
+    b = [1.570796288, 0.03706987906, -0.8364353589e-3,
+         -0.2250947176e-3, 0.6841218299e-5, 0.5824238515e-5,
+         -0.104527497e-5, 0.8360937017e-7, -0.3231081277e-8,
+         0.3657763036e-10, 0.6936233982e-12]
+
+    if(qn < 0.0 || 1.0 < qn)
+      $stderr.printf("Error : qn <= 0 or qn >= 1  in pnorm()!\n")
+      return 0.0;
+    end
+    qn == 0.5 and return 0.0
+
+    w1 = qn
+    qn > 0.5 and w1 = 1.0 - w1
+    w3 = -Math.log(4.0 * w1 * (1.0 - w1))
+    w1 = b[0]
+    1.upto 10 do |i|
+      w1 += b[i] * w3**i;
+    end
+    qn > 0.5 and return Math.sqrt(w1 * w3)
+    -Math.sqrt(w1 * w3)
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require "bundler/setup"
+Bundler.require(:default)
+require "minitest/autorun"
+require "minitest/pride"

data/test/wilson_score_test.rb

@@ -0,0 +1,29 @@
+require_relative "test_helper"
+
+class TestWilsonScore < Minitest::Test
+
+  def test_wilson_score
+    interval = WilsonScore.interval(1, 2, 0.95)
+    assert_in_delta 0.0945, interval.first
+    assert_in_delta 0.9055, interval.last
+  end
+
+  def test_continuity_correction
+    interval = WilsonScore.interval(1, 2, 0.95, true)
+    assert_in_delta 0.0267, interval.first
+    assert_in_delta 0.9733, interval.last
+  end
+
+  def test_rating
+    interval = WilsonScore.rating_interval(5, 1, 1..5, 0.95)
+    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)
+    assert_in_delta 2.4998, interval.first
+    assert_in_delta 4.5117, interval.last
+  end
+
+end

data/wilson_score.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'wilson_score/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "wilson_score"
+  spec.version       = WilsonScore::VERSION
+  spec.authors       = ["Andrew Kane"]
+  spec.email         = ["andrew@chartkick.com"]
+  spec.description   = %q{Simple, dependency-free Wilson score}
+  spec.summary       = %q{Simple, dependency-free Wilson score}
+  spec.homepage      = "https://github.com/instacart/wilson_score"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: wilson_score
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrew Kane
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-28 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
+email:
+- andrew@chartkick.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/wilson_score.rb
+- lib/wilson_score/version.rb
+- test/test_helper.rb
+- test/wilson_score_test.rb
+- wilson_score.gemspec
+homepage: https://github.com/instacart/wilson_score
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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
+signing_key: 
+specification_version: 4
+summary: Simple, dependency-free Wilson score
+test_files:
+- test/test_helper.rb
+- test/wilson_score_test.rb