descriptive-statistics 0.0.2 → 1.0.0

data/README.md

@@ -29,6 +29,21 @@ stats.median #=> 2
 stats.mode #=> 1
 ```
 
+### Dispersion:
+```ruby
+stats = DescriptiveStatistics.new([1,1,2,3,10])
+stats.range #=> 9
+stats.percentile_from_value(10) #=> 80
+stats.value_from_percentile(60) #=> 3
+```
+
+### Spread:
+```ruby
+stats = DescriptiveStatistics.new([1,1,2,3,10])
+stats.variance #=> 14.299999999999999
+stats.standard_deviation #=> 3.7815340802378072
+```
+
 ## Contributing
 
 1. Fork it

data/lib/descriptive-statistics.rb

@@ -1,9 +1,13 @@
 require "descriptive-statistics/version"
 require 'descriptive-statistics/central-tendency'
+require 'descriptive-statistics/dispersion'
+require 'descriptive-statistics/spread'
 
 class DescriptiveStatistics
   extend Forwardable
   include CentralTendency
+  include Dispersion
+  include Spread
 
   def initialize(data)
     @data = data

data/lib/descriptive-statistics/central-tendency.rb

@@ -32,15 +32,5 @@ class DescriptiveStatistics
         top_2.first.first # Most frequent is mode.
       end
     end
-
-    def sample_variance
-      sum = self.inject(0) {|accumulator, value| accumulator + (value - mean) ** 2 }
-      sum / (length.to_f - 1)
-    end
-
-    def standard_deviation
-      return if length < 2
-      Math.sqrt(sample_variance)
-    end
   end
 end

data/lib/descriptive-statistics/dispersion.rb

@@ -0,0 +1,20 @@
+class DescriptiveStatistics
+  module Dispersion
+    def range
+      return if length < 1
+      sorted = sort
+      sorted.last - sorted.first
+    end
+
+    def percentile_from_value(value)
+      return if length < 1
+      (sort.index(value) / length.to_f * 100).ceil
+    end
+
+    def value_from_percentile(percentile)
+      return if length < 1
+      value_index = (percentile.to_f / 100 * length).ceil
+      sort[value_index]
+    end
+  end
+end

data/lib/descriptive-statistics/spread.rb

@@ -0,0 +1,25 @@
+class DescriptiveStatistics
+  module Spread
+    def variance
+      return if length < 1
+      sum = self.inject(0) {|accumulator, value| accumulator + (value - mean) ** 2 }
+      sum / (length.to_f - 1)
+    end
+
+    def population_variance
+      return if length < 1
+      sum = self.inject(0) {|accumulator, value| accumulator + (value - mean) ** 2 }
+      sum / length.to_f
+    end
+
+    def standard_deviation
+      return if length < 2
+      Math.sqrt(variance)
+    end
+
+    def population_standard_deviation
+      return if length < 2
+      Math.sqrt(population_variance)
+    end
+  end
+end

data/lib/descriptive-statistics/version.rb

@@ -1,5 +1,5 @@
 module Descriptive
   module Statistics
-    VERSION = "0.0.2"
+    VERSION = "1.0.0"
   end
 end

data/spec/lib/descriptive-statistics/dispersion_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe DescriptiveStatistics::Dispersion do
+  describe '#range' do
+    it 'returns the mean squared deviation of the sample (n - 1 denominator)' do
+      DescriptiveStatistics.new([1,2,6]).range.should == 5
+    end
+
+    it 'returns nil if empty' do
+      DescriptiveStatistics.new([]).range.should be_nil
+    end
+  end
+
+  describe '#percentile_from_value' do
+    it 'returns the precise percentile of each value' do
+      data = [95.1772, 95.1567, 95.1937, 95.1959, 95.1442, 95.061, 95.1591, 95.1195,95.1065, 95.0925, 95.199, 95.1682]
+      percentiles = [0,9,17,25,34,42,50,59,67,75,84,92]
+      stats = DescriptiveStatistics.new(data)
+      data.sort.each_with_index do |datum, i|
+        stats.percentile_from_value(datum).should == percentiles[i]
+      end
+    end
+
+    it 'returns nil if empty' do
+      DescriptiveStatistics.new([]).percentile_from_value(1).should be_nil
+    end
+  end
+
+  describe '#value_from_percentile' do
+    it 'returns the precise percentile of each value' do
+      data = [95.1772, 95.1567, 95.1937, 95.1959, 95.1442, 95.061, 95.1591, 95.1195,95.1065, 95.0925, 95.199, 95.1682]
+      percentiles = [0,10,20,30,40,50,60,70,80,90]
+      values = [95.061,95.1065,95.1195,95.1442,95.1567,95.1591,95.1772,95.1937,95.1959,95.199]
+      stats = DescriptiveStatistics.new(data)
+      percentiles.sort.each_with_index do |percentile, i|
+        stats.value_from_percentile(percentile).should == values[i]
+      end
+    end
+
+    it 'returns nil if empty' do
+      DescriptiveStatistics.new([]).value_from_percentile(1).should be_nil
+    end
+  end
+end

data/spec/lib/descriptive-statistics/spread_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe DescriptiveStatistics::Spread do
+  describe '#variance' do
+    it 'returns the mean squared deviation of the sample (n - 1 denominator)' do
+      DescriptiveStatistics.new([1,2,6]).variance.should == 7
+    end
+
+    it 'returns nil if empty' do
+      DescriptiveStatistics.new([]).variance.should be_nil
+    end
+  end
+
+  describe '#population_variance' do
+    it 'returns the mean squared deviation of the sample' do
+      DescriptiveStatistics.new([1,2,3,4]).population_variance.should == 1.25
+    end
+
+    it 'returns nil if empty' do
+      DescriptiveStatistics.new([]).population_variance.should be_nil
+    end
+  end
+
+  describe '#standard_deviation' do
+    it 'returns the square root of the variance' do
+      DescriptiveStatistics.new([1,2,6]).standard_deviation.should == 2.6457513110645907
+    end
+
+    it 'returns nil if empty' do
+      DescriptiveStatistics.new([]).standard_deviation.should be_nil
+    end
+  end
+
+  describe '#population_standard_deviation' do
+    it 'returns the square root of the population_variance' do
+      DescriptiveStatistics.new([1,2,6]).population_standard_deviation.should == 2.160246899469287
+    end
+
+    it 'returns nil if empty' do
+      DescriptiveStatistics.new([]).population_standard_deviation.should be_nil
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: descriptive-statistics
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -59,8 +59,12 @@ files:
 - descriptive-statistics.gemspec
 - lib/descriptive-statistics.rb
 - lib/descriptive-statistics/central-tendency.rb
+- lib/descriptive-statistics/dispersion.rb
+- lib/descriptive-statistics/spread.rb
 - lib/descriptive-statistics/version.rb
 - spec/lib/descriptive-statistics/central_tendency_spec.rb
+- spec/lib/descriptive-statistics/dispersion_spec.rb
+- spec/lib/descriptive-statistics/spread_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/jtescher/descriptive-statistics
 licenses: []
@@ -76,7 +80,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3988520921431193355
+      hash: -2781553124124914132
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -85,7 +89,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3988520921431193355
+      hash: -2781553124124914132
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -95,4 +99,6 @@ summary: Simply calculate measures of central tendency (e.g. mean, median mode),
   (e.g. range and quartiles), and spread (e.g variance and standard deviation)
 test_files:
 - spec/lib/descriptive-statistics/central_tendency_spec.rb
+- spec/lib/descriptive-statistics/dispersion_spec.rb
+- spec/lib/descriptive-statistics/spread_spec.rb
 - spec/spec_helper.rb