wilson_interval 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bb25f95060ae5c27f138c0bc4069a87b7c97b4b7
+  data.tar.gz: b08c3c8da284f9db7ea8640f12e0d33ba74535aa
+SHA512:
+  metadata.gz: f54eb254fb3bcb8eba4732be69897bed10b0d923eec11d41b35dec8340dea150de5bfe4e7a9bb2c73bab2bb3d9e533b16f1b91e2c541d78dcdd9c8bef5b9f352
+  data.tar.gz: c510afe2f439306628709489ad4ab38f1fc56d3ddfc05db44ac8105e364363a05424f69c2d6ff441cfd7652eb562304f5cb0e907b0a566e3066c67a90d453525

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.ruby-gemset

@@ -0,0 +1 @@
+wilson_interval

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.0.0-p0

data/Gemfile

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+
+gem 'statistics2', '>= 0.54'
+
+group :development do
+  gem 'jeweler', '>= 1.8.6'
+end
+
+group :test do
+  gem 'rspec'
+end

data/Gemfile.lock

@@ -0,0 +1,61 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.3.5)
+    builder (3.2.2)
+    diff-lcs (1.2.4)
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
+    git (1.2.5)
+    github_api (0.10.1)
+      addressable
+      faraday (~> 0.8.1)
+      hashie (>= 1.2)
+      multi_json (~> 1.4)
+      nokogiri (~> 1.5.2)
+      oauth2
+    hashie (2.0.5)
+    highline (1.6.19)
+    httpauth (0.2.0)
+    jeweler (1.8.6)
+      builder
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      github_api (= 0.10.1)
+      highline (>= 1.6.15)
+      nokogiri (= 1.5.10)
+      rake
+      rdoc
+    jwt (0.1.8)
+      multi_json (>= 1.5)
+    multi_json (1.7.8)
+    multi_xml (0.5.5)
+    multipart-post (1.2.0)
+    nokogiri (1.5.10)
+    oauth2 (0.9.2)
+      faraday (~> 0.8)
+      httpauth (~> 0.2)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.5.2)
+    rake (10.0.4)
+    rdoc (4.0.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.4)
+    rspec-expectations (2.14.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.2)
+    statistics2 (0.54)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jeweler (>= 1.8.6)
+  rspec
+  statistics2 (>= 0.54)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Magnus von Koeller
+
+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,36 @@
+# wilson_interval
+
+Calculate Wilson confidence intervals with minimum fuss.
+
+## Usage
+
+You always need to specify ```:total``` and ```:confidence```. You also need to specify *either* ```:p_hat``` *or* ```:successes```. The ```:confidence``` option is optional and defaults to ```0.95```.
+
+```ruby
+wilson = Wilson::Interval.new(p_hat: 0.5, total: 1000, confidence: 0.95)
+wilson.lower_bound.round(4) => 0.4691
+wilson.upper_bound.round(4) => 0.5309
+
+wilson = Wilson::Interval.new(successes: 500, total: 1000, confidence: 0.95)
+wilson.lower_bound.round(4) => 0.4691
+wilson.upper_bound.round(4) => 0.5309
+```
+
+## Credits
+
+Based on code found at [evanmiller.org](http://www.evanmiller.org/how-not-to-sort-by-average-rating.html). Adapted according to [Wikipedia](http://en.wikipedia.org/wiki/Binomial_proportion_confidence_interval#Wilson_score_interval).
+
+## Contributing to wilson_interval
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2013 Magnus von Koeller. Licensed under the MIT license. See LICENSE.txt for further details.
+

data/Rakefile

@@ -0,0 +1,26 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "wilson_interval"
+  gem.homepage = "http://github.com/magnusvk/wilson_interval"
+  gem.license = "MIT"
+  gem.summary = %Q{Calculate Wilson confidence intervals with minimum fuss.}
+  gem.description = %Q{Makes it super easy to calculate Wilson confidence intervals.}
+  gem.email = "magnus@vonkoeller.de"
+  gem.authors = ["Magnus von Koeller"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/wilson_interval.rb

@@ -0,0 +1,43 @@
+require 'statistics2'
+
+module Wilson
+  class Interval
+    def initialize(options)
+      @o = options
+      @o[:confidence] ||= 0.95
+
+      raise "Need to specify :n" unless @o[:total]
+      unless @o[:p_hat]
+        raise "Need to specify :p_hat or :successes" unless @o[:successes]
+        @o[:p_hat] = @o[:successes].to_f / @o[:total] unless @o[:total] == 0
+      end
+    end
+
+    def lower_bound
+      return nil if @o[:total] == 0
+      (center - plus_minus) / denominator
+    end
+
+    def upper_bound
+      return nil if @o[:total] == 0
+      (center + plus_minus) / denominator
+    end
+
+    private
+    def z
+      Statistics2.pnormaldist(1-(1-@o[:confidence])/2)
+    end
+
+    def center
+      @o[:p_hat] + z*z/(2*@o[:total])
+    end
+    
+    def plus_minus
+      z * Math.sqrt((@o[:p_hat]*(1-@o[:p_hat])+z*z/(4*@o[:total]))/@o[:total])
+    end
+
+    def denominator
+      1 + z*z / @o[:total]
+    end
+  end
+end

data/spec/wilson_interval_spec.rb

@@ -0,0 +1,57 @@
+require 'wilson_interval'
+
+describe "Wilson::Interval" do
+  it "returns correct z" do
+    wilson = Wilson::Interval.new(p_hat: 0.5, total: 1000, confidence: 0.99)
+    wilson.send(:z).round(8).should == 2.57582933
+
+    wilson = Wilson::Interval.new(p_hat: 0.5, total: 1000, confidence: 0.95)
+    wilson.send(:z).round(8).should == 1.95996397
+
+    wilson = Wilson::Interval.new(p_hat: 0.5, total: 1000, confidence: 0.50)
+    wilson.send(:z).round(8).should == 0.67448976 
+
+    wilson = Wilson::Interval.new(p_hat: 0.5, total: 1000, confidence: 0.25)
+    wilson.send(:z).round(8).should == 0.31863936
+  end
+
+  it "correctly calculates p_hat" do
+    wilson = Wilson::Interval.new(p_hat: 0.5, total: 1000, confidence: 0.95)
+    wilson.lower_bound.round(4).should == 0.4691
+    wilson.upper_bound.round(4).should == 0.5309
+
+    wilson = Wilson::Interval.new(successes: 500, total: 1000, confidence: 0.95)
+    wilson.lower_bound.round(4).should == 0.4691
+    wilson.upper_bound.round(4).should == 0.5309
+  end
+
+  it "correctly calculates lower and upper bounds" do
+    wilson = Wilson::Interval.new(successes: 500, total: 1000, confidence: 0.99)
+    wilson.lower_bound.round(4).should == 0.4594
+    wilson.upper_bound.round(4).should == 0.5406
+
+    wilson = Wilson::Interval.new(successes: 500, total: 1000, confidence: 0.95)
+    wilson.lower_bound.round(4).should == 0.4691
+    wilson.upper_bound.round(4).should == 0.5309
+
+    wilson = Wilson::Interval.new(successes: 500, total: 1000, confidence: 0.50)
+    wilson.lower_bound.round(4).should == 0.4893
+    wilson.upper_bound.round(4).should == 0.5107
+
+    wilson = Wilson::Interval.new(successes: 1000, total: 1000, confidence: 0.95)
+    wilson.lower_bound.round(4).should == 0.9962
+    wilson.upper_bound.round(4).should == 1
+
+    wilson = Wilson::Interval.new(successes: 0, total: 1000, confidence: 0.95)
+    wilson.lower_bound.round(4).should == 0
+    wilson.upper_bound.round(4).should == 0.0038
+
+    wilson = Wilson::Interval.new(successes: 250, total: 1000, confidence: 0.95)
+    wilson.lower_bound.round(4).should == 0.2242
+    wilson.upper_bound.round(4).should == 0.2778
+
+    wilson = Wilson::Interval.new(successes: 750, total: 1000, confidence: 0.95)
+    wilson.lower_bound.round(4).should == 0.7222
+    wilson.upper_bound.round(4).should == 0.7758
+  end
+end

data/wilson_interval.gemspec

@@ -0,0 +1,54 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "wilson_interval"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Magnus von Koeller"]
+  s.date = "2013-08-06"
+  s.description = "Makes it super easy to calculate Wilson confidence intervals."
+  s.email = "magnus@vonkoeller.de"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".ruby-gemset",
+    ".ruby-version",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/wilson_interval.rb",
+    "spec/wilson_interval_spec.rb",
+    "wilson_interval.gemspec"
+  ]
+  s.homepage = "http://github.com/magnusvk/wilson_interval"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "2.0.3"
+  s.summary = "Calculate Wilson confidence intervals with minimum fuss."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<statistics2>, [">= 0.54"])
+      s.add_development_dependency(%q<jeweler>, [">= 1.8.6"])
+    else
+      s.add_dependency(%q<statistics2>, [">= 0.54"])
+      s.add_dependency(%q<jeweler>, [">= 1.8.6"])
+    end
+  else
+    s.add_dependency(%q<statistics2>, [">= 0.54"])
+    s.add_dependency(%q<jeweler>, [">= 1.8.6"])
+  end
+end
+

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: wilson_interval
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Magnus von Koeller
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: statistics2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0.54'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0.54'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.8.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.8.6
+description: Makes it super easy to calculate Wilson confidence intervals.
+email: magnus@vonkoeller.de
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .document
+- .ruby-gemset
+- .ruby-version
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/wilson_interval.rb
+- spec/wilson_interval_spec.rb
+- wilson_interval.gemspec
+homepage: http://github.com/magnusvk/wilson_interval
+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.3
+signing_key: 
+specification_version: 4
+summary: Calculate Wilson confidence intervals with minimum fuss.
+test_files: []