basic-stats 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5e3801e30fbbe3d7b3e731e1a5feca120b5915de
+  data.tar.gz: b738414f640c231200c547ded2eeb7de13804231
+SHA512:
+  metadata.gz: d963ad59b357a9dbee66f352cf5d447a7b1330a6bf7f1f66cfb103d672ee527e3037ee6a4cc348d4217b9e9ad64a5f29b813a15dabd6e330aabd8ff816771da7
+  data.tar.gz: 1118862cb6811aea2417a3e66c122cf320dc70bfc7e27294f44fa0d316ee5168ca73ee2f771d7ef2e60c8684773db26a8ccb95260e21f64e6c127fad0a6ef0c6

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/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Christopher Petersen
+
+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,58 @@
+# Basic::Stats
+
+Basic statistical functions for Ruby collections, such as mean, standard_deviation, z, and outlier detection
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'basic-stats'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install basic-stats
+
+If you aren't using rails, you may have to require the ```basic/stats``` file.
+
+    require 'basic/stats'
+
+## Usage
+
+To use basic stat's methods, include the module in your array
+
+```ruby
+  array = [1,2,3,4,5,6,7,8,9,10]
+  array.extend Basic::Stats
+  array.mean
+  array.standard_deviation
+  array.critical_z
+  array.z(5)
+```
+
+Once you've included the module, you can also use outlier detection
+
+```ruby
+  array = [1,2,3,4,5,6,7,8,9,30]
+  array.extend Basic::Stats
+  array.select_outliers
+  array.reject_outliers
+  array.reject_outliers!  
+```
+
+## Notes on outlier detection
+
+```basic-stats``` uses the [Grubb's test](http://en.wikipedia.org/wiki/Grubbs'_test_for_outliers) for outlier detection. Specically it assumes an alpha of 5%, meaning you will mistakenly identify an outlier in 5% of your samples. More information [here](http://graphpad.com/support/faqid/1598/).
+
+The Grubb's test does not work well for detecting multiple outliers.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/basic-stats.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'basic/stats/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "basic-stats"
+  spec.version       = Basic::Stats::VERSION
+  spec.authors       = ["Christopher Petersen"]
+  spec.email         = ["chris@petersen.io"]
+  spec.description   = %q{Basic statistical functions for Ruby collections, such as mean, standard_deviation, z, and outlier detection}
+  spec.summary       = %q{Basic statistical functions for Ruby collections, such as mean, standard_deviation, z, and outlier detection}
+  spec.homepage      = "http://github.com/cpetersen/basic-stats"
+  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 "rspec"
+end

data/lib/basic/stats.rb

@@ -0,0 +1,106 @@
+require "basic/stats/version"
+
+module Basic
+  module Stats
+    def sum
+      self.inject(0){|accum, i| accum + i }
+    end
+
+    def mean
+      self.sum/self.length.to_f
+    end
+
+    def sample_variance
+      m = self.mean
+      sum = self.inject(0){|accum, i| accum +(i-m)**2 }
+      sum/(self.length - 1).to_f
+    end
+
+    def standard_deviation
+      return Math.sqrt(self.sample_variance)
+    end
+
+    def z(value)
+      (self.mean - value).abs/standard_deviation
+    end
+
+    def critical_z
+      Stats.critical_z(self.size)
+    end
+
+    def reject_outliers
+      cz = self.critical_z
+      self.reject { |value| z(value) > cz }
+    end
+
+    def reject_outliers!
+      cz = self.critical_z
+      self.reject! { |value| z(value) > cz }
+    end
+
+    def select_outliers
+      cz = self.critical_z
+      self.select { |value| z(value) > cz }
+    end
+
+    @@critical_z_table = {
+      3 => 1.15,
+      4 => 1.48,
+      5 => 1.71,
+      6 => 1.89,
+      7 => 2.02,
+      8 => 2.13,
+      9 => 2.21,
+      10 => 2.29,
+      11 => 2.34,
+      12 => 2.41,
+      13 => 2.46,
+      14 => 2.51,
+      15 => 2.55,
+      16 => 2.59,
+      17 => 2.62,
+      18 => 2.65,
+      19 => 2.68,
+      20 => 2.71,
+      21 => 2.73,
+      22 => 2.76,
+      23 => 2.78,
+      24 => 2.80,
+      25 => 2.82,
+      26 => 2.84,
+      27 => 2.86,
+      28 => 2.88,
+      29 => 2.89,
+      30 => 2.91,
+      31 => 2.92,
+      32 => 2.94,
+      33 => 2.95,
+      34 => 2.97,
+      35 => 2.98,
+      36 => 2.99,
+      37 => 3.00,
+      38 => 3.01,
+      39 => 3.03,
+      40 => 3.04,
+      50 => 3.13,
+      60 => 3.20,
+      70 => 3.26,
+      80 => 3.31,
+      90 => 3.35,
+      100 => 3.38,
+      110 => 3.42,
+      120 => 3.44,
+      130 => 3.47,
+      140 => 3.49
+    }
+
+    def self.critical_z(n)
+      result = nil
+      @@critical_z_table.keys.sort.each do |key|
+        break if key > n
+        result = @@critical_z_table[key]
+      end
+      result
+    end
+  end
+end

data/lib/basic/stats/version.rb

@@ -0,0 +1,5 @@
+module Basic
+  module Stats
+    VERSION = "0.0.1"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require "basic/stats"
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/stats_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+
+describe Basic::Stats do
+  let(:array) { [1,2,3,4,5,6,7,8,9,10].extend Basic::Stats }
+  let(:array_with_outlier) { [1,2,3,4,5,6,7,8,9,30].extend Basic::Stats }
+
+  it "should have a mean of 5.5" do
+    array.mean.should == 5.5
+  end
+
+  it "should have a standard deviation of 3.02765..." do
+    array.standard_deviation.should == 3.0276503540974917
+  end
+
+  it "should have a sample variance of 9.1666..." do
+    array.sample_variance.should == 9.166666666666666
+  end
+
+  it "should have a critical z of 2.29" do
+    array.critical_z.should == 2.29
+  end
+
+  it "should reject an outlier (copy)" do
+    new_array = array_with_outlier.reject_outliers
+    new_array.size.should == (array_with_outlier.size-1)
+  end
+
+  it "should reject an outlier (mutate)" do
+    expect {
+      array_with_outlier.reject_outliers!
+    }.to change{array_with_outlier.size}.by(-1)
+  end
+
+  it "should select outliers" do
+    outliers = array_with_outlier.select_outliers
+    outliers.should == [30]
+  end
+
+  describe "z" do
+    it "of 3 should be 0.82572" do
+      array.z(3).should == 0.8257228238447705
+    end
+
+    it "of 10 should be 1.48630" do
+      array.z(10).should == 1.4863010829205867
+    end
+  end
+
+  describe "critical z" do
+    it "of 0 should be nil" do
+      Basic::Stats.critical_z(0).should be_nil
+    end
+
+    it "of 1 should be nil" do
+      Basic::Stats.critical_z(1).should be_nil
+    end
+
+    it "of 3 should be 1.15" do
+      Basic::Stats.critical_z(3).should == 1.15
+    end
+
+    it "of 20 should be 2.71" do
+      Basic::Stats.critical_z(20).should == 2.71
+    end
+
+    it "of 45 should be 3.04" do
+      Basic::Stats.critical_z(45).should == 3.04
+    end
+
+    it "of 200 should be 3.49" do
+      Basic::Stats.critical_z(200).should == 3.49
+    end
+  end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: basic-stats
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Christopher Petersen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-20 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: rspec
+  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: Basic statistical functions for Ruby collections, such as mean, standard_deviation,
+  z, and outlier detection
+email:
+- chris@petersen.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- basic-stats.gemspec
+- lib/basic/stats.rb
+- lib/basic/stats/version.rb
+- spec/spec_helper.rb
+- spec/stats_spec.rb
+homepage: http://github.com/cpetersen/basic-stats
+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: Basic statistical functions for Ruby collections, such as mean, standard_deviation,
+  z, and outlier detection
+test_files:
+- spec/spec_helper.rb
+- spec/stats_spec.rb