ministat 1.0.0

data/History.txt

@@ -0,0 +1,5 @@
+== 0.9.0 / 2007-08-02
+
+* 1 major enhancement
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,16 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/ministat
+lib/ministat.rb
+package/History.txt
+package/Manifest.txt
+package/README.txt
+package/Rakefile
+package/bin/package
+package/lib/package.rb
+package/test/test_package.rb
+test/data/1.dat
+test/data/2.dat
+test/test_ministat.rb

data/README.txt

@@ -0,0 +1,59 @@
+ministat
+    by Dean Hudson
+    ero.com
+
+== DESCRIPTION:
+  
+This is a simple package that generates simple statistical info on
+numerical data sets of a single variable. It's nothing too fancy, but
+maybe just enough to coat your numbers with a thin layer of science. Or,
+at least to get you thinking about what it may take to do so.
+
+== FEATURES/PROBLEMS:
+
+* Pure Ruby
+* It's small and simple
+* It's probably good enough
+* I haven't profiled it against large data sets
+* Naive median implementation requires a sort, but it could be done in linear time. Patches welcome.
+* Missing tests for harmonic and geometric mean -- the stats package I was generating test data with didn't have them.
+
+== SYNOPSIS:
+
+  require 'ministat'
+ 
+  data = [1,2,3,4,5,6,7,7,6,5,4,4]
+  puts MiniStat::Data.new(data).to_s
+
+== REQUIREMENTS:
+
+  Hoe
+
+== INSTALL:
+
+  sudo gem install ministat
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2007 Dean Hudson
+
+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/Rakefile

@@ -0,0 +1,17 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/ministat.rb'
+
+Hoe.new('ministat', MiniStat::VERSION) do |p|
+  p.rubyforge_name = 'ministat'
+  p.author = 'Dean Hudson'
+  p.email = 'dean@ero.com'
+  p.summary = 'A small and simple library to generate statistical info on single-variable datasets.'
+  p.description = p.paragraphs_of('README.txt', 2..5).join("\n\n")
+  p.url = p.paragraphs_of('README.txt', 0).first.split(/\n/)[1..-1]
+  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+end
+
+# vim: syntax=Ruby

data/bin/ministat

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby -ws
+
+require 'ministat'
+
+if $f and File.exists($f)
+  lines = []
+  lines = File.readlines($f).each {|l| l.chomp!}
+  puts MiniStat::Data.new(lines).to_s
+else
+  puts "Usage: ministat -f datafile"
+end

data/lib/ministat.rb

@@ -0,0 +1,127 @@
+require 'mathn'
+
+module MiniStat
+  VERSION = '1.0.0'   
+  class Data
+    attr_reader :data
+
+    def initialize(data)
+      @data = data.collect {|data| data.to_f}.sort
+      @sorted = true
+    end
+
+    # Return the median of your dataset. Naive implementaion
+    # -- does a sort on the data.
+    def median(data=@data)
+      unless @sorted and data == @data
+        data.sort!
+        @sort = true
+      end
+      if data.size % 2 == 0
+        return (data[data.size / 2 - 1] + data[(data.size / 2)]) / 2
+      else 
+        split = (data.size + 1) / 2
+        return (data[split - 1.5] + data[split - 0.5]) / 2
+      end
+    end
+
+    def partition(pivot, data=@data)
+      low  = []
+      high = []
+      data.each do |i|
+        high.push(i) if i > pivot
+        low.push(i)  if i < pivot
+      end
+      return {:low => low, :high => high}
+    end
+
+    # First quartile.
+    def q1
+      @q1 ||= median(partition(median(@data), @data)[:low])
+    end
+
+    # Third quartile
+    def q3
+      @q3 ||= median(partition(median(@data), @data)[:high])
+    end
+
+    # Interquartile range, ie the middle 50% of the data.
+    def iqr
+      @iqr ||= q3 - q1
+    end
+
+    # Returns an array of outlying data points.
+    def outliers
+      @outliers ||= 
+        @data.collect do |i|
+          i if (i < q1 - (1.5 * iqr) or i > q3 + (1.5 * iqr))
+        end.compact
+    end
+
+    # Computes arthmetic mean (most common average).
+    def mean(data=@data)
+      (data.inject(0) {|i,j| i += j}) / data.size
+    end
+
+    # Computes mode and a histogram.
+    def mode
+      @hist     ||= {}
+      @max_freq ||= 0
+      @mode     ||= nil
+      unless @mode
+        @data.each do |val|
+          @hist[val] ||= 0
+          @hist[val] += 1
+          @max_freq, @mode = @hist[val], val if @hist[val] > @max_freq
+         end
+      end
+      @mode
+    end
+
+    # Computes variance. Used to measure degree of spread 
+    # in dataset.
+    def variance
+      @variance ||= 
+        @data.inject(0) { |i,j| i += (j - mean(@data)) ** 2}  / (@data.size)
+    end
+
+    # Standard deviation. Square root of variance, measure of the
+    # spread of the data about the mean.
+    def std_dev
+      @std_dev ||= Math.sqrt(variance)
+    end
+
+    # Geometric mean. Only applies to non-negative numbers, and
+    # relates to log-normal distribution.
+    def geometric_mean
+      @geoeteric_mean ||= 
+        (@data.inject(1) {|i,j| i *= j})**(1.0/@data.size)
+    end
+
+    # Harmonic or subcontrary mean. Tends strongly toward the least
+    # elements of the dataset.
+    def harmonic_mean
+      @harmonic_mean ||=
+         @data.size.to_f / (@data.inject(0) {|i,j| i += (1.0/j)})
+    end
+
+    # Return a string with statisical info about a dataset.
+    def to_s
+      <<-DATA_STR    
+        Partition:#{partition(median).inspect} 
+        Mean:#{mean}
+        Geometric Mean:#{geometric_mean}
+        Harmonic Mean:#{harmonic_mean}
+        Median:#{median} 
+        Min:#{data.min} 
+        Q1:#{q1}
+        Q3:#{q3}
+        Max:#{data.max}
+        IQR:#{iqr}
+        Outliers:#{outliers.inspect}
+        Variance:#{variance} 
+        Std Dev:#{std_dev}
+      DATA_STR
+    end
+  end  
+end

data/package/History.txt

@@ -0,0 +1,5 @@
+== 1.0.0 / 2007-11-06
+
+* 1 major enhancement
+  * Birthday!
+

data/package/Manifest.txt

@@ -0,0 +1,7 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/package
+lib/package.rb
+test/test_package.rb

data/package/README.txt

@@ -0,0 +1,48 @@
+package
+    by FIX (your name)
+    FIX (url)
+
+== DESCRIPTION:
+  
+FIX (describe your package)
+
+== FEATURES/PROBLEMS:
+  
+* FIX (list of features or problems)
+
+== SYNOPSIS:
+
+  FIX (code sample of usage)
+
+== REQUIREMENTS:
+
+* FIX (list of requirements)
+
+== INSTALL:
+
+* FIX (sudo gem install, anything else)
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2007 FIX
+
+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/package/Rakefile

@@ -0,0 +1,17 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/package.rb'
+
+Hoe.new('package', Package::VERSION) do |p|
+  p.rubyforge_name = 'package'
+  # p.author = 'FIX'
+  # p.email = 'FIX'
+  # p.summary = 'FIX'
+  # p.description = p.paragraphs_of('README.txt', 2..5).join("\n\n")
+  # p.url = p.paragraphs_of('README.txt', 0).first.split(/\n/)[1..-1]
+  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+end
+
+# vim: syntax=Ruby

data/package/lib/package.rb

@@ -0,0 +1,3 @@
+class Package
+  VERSION = '1.0.0'
+end

data/test/data/1.dat

@@ -0,0 +1,28 @@
+0.2
+0.5
+0.7
+0.8
+0.9
+0.95
+1
+1.1
+1.2
+1.21
+1.32
+1.4
+1.6
+1.7
+1.77
+1.8
+2
+2.2
+2.4
+2.6
+2.88
+3.1
+3.5
+3.9
+4.3
+4.8
+5.2
+6

data/test/data/2.dat

@@ -0,0 +1,83 @@
+-5.7
+1.2
+4.1
+3.2
+7.3
+7.5
+18.6
+3.7
+-1.8
+2.4
+-6.5
+6.7
+9.4
+-2.0
+-2.8
+-3.4
+19.2
+-4.8
+0.5
+-0.6
+2.8
+-0.5
+-4.5
+8.7
+2.7
+4.1
+-10.3
+4.8
+-2.3
+-3.1
+-10.2
+-3.7
+-26.6
+7.2
+-2.9
+-2.3
+3.5
+-4.6
+17.2
+4.2
+0.5
+8.3
+-7.1
+-8.4
+7.7
+-9.6
+6
+6.8
+10.9
+1.6
+0.2
+-2.4
+-2.4
+3.9
+1.7
+9.0
+3.6
+7.6
+3.2
+-3.7
+4.2
+13.2
+.9
+4.2
+4
+2.8
+6.7
+-10.4
+2.7
+10.3
+5.7
+.6
+-14.2
+1.3
+2.9
+11.8
+10.6
+5.2
+13.8
+-14.7
+3.5
+11.7
+1.3

data/test/test_ministat.rb

@@ -0,0 +1,79 @@
+# Code Generated by ZenTest v. 3.6.1
+#                 classname: asrt / meth =  ratio%
+#                  MiniStat:    0 /   10 =   0.00%
+
+require 'test/unit' unless defined? $ZENTEST and $ZENTEST
+require 'ministat' 
+require 'rubygems'
+require 'ruby-debug'                                                      
+
+class TestMiniStat < Test::Unit::TestCase
+  def setup
+    @data1 = [34, 47, 1, 15, 57, 24, 20, 11, 19, 50, 28, 37]
+    @data2 = [60, 56, 61, 68, 51, 53, 69, 54]                  
+    @data3 = File.open('test/data/1.dat').map {|l| l.chomp}
+    @data4 = File.open('test/data/2.dat').map {|l| l.chomp}
+    @ms1   = MiniStat::Data.new(@data1)
+    @ms2   = MiniStat::Data.new(@data2)
+    @ms3   = MiniStat::Data.new(@data3)
+    @ms4   = MiniStat::Data.new(@data4)
+    # we test to within a tolerance to schluff off
+    # possible floating point and rounding errors
+    @error = 0.001 
+  end
+
+  def test_iqr
+    assert(@ms1.iqr - 25 < @error)
+  end                                                   
+
+  def test_mean
+    assert(@ms2.mean - 59 < @error)
+    assert(@ms3.mean - 2.179 < @error)
+    assert(@ms4.mean - 1.878 < @error)
+  end
+
+  def test_median
+    assert(@ms1.median - 26 < @error)
+    assert(@ms3.median - 1.735 < @error)
+    assert(@ms3.median - 2.8 < @error)
+  end
+
+  def test_mode
+    ms = MiniStat::Data.new([1,1,1,2,3,4,5])
+    assert_equal(ms.mode, 1)
+    ms = MiniStat::Data.new([1,2,2,2,2,3,4,5])
+    assert_equal(ms.mode, 2)
+  end
+
+  def test_outliers
+    assert_equal(@ms1.outliers, [])
+  end
+
+  def test_q1
+    assert(@ms1.q1 - 17 < @error)   
+    assert(@ms3.q1 - 1.05 < @error)
+    assert(@ms4.q1 - -2.6 < @error)
+  end
+
+  def test_q3
+    assert(@ms1.q3 - 42 < @error)
+    assert(@ms3.q3 - 2.99 < @error)
+    assert(@ms4.q3 - 6.75 < @error)
+  end
+
+  def test_std_dev
+   assert(@ms2.std_dev - 6.324 < @error)
+   assert(@ms3.std_dev - 1.515 < @error)
+   assert(@ms4.std_dev - 7.553 < @error)
+  end
+
+  def test_geo_mean
+    # debugger
+  end
+
+  def test_harm_mean
+    # debugger
+  end
+end
+
+# Number of errors detected: 11

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.4
+specification_version: 1
+name: ministat
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+date: 2007-11-11 00:00:00 -08:00
+summary: A small and simple library to generate statistical info on single-variable datasets.
+require_paths: 
+- lib
+email: dean@ero.com
+homepage: "    by Dean Hudson"
+rubyforge_project: ministat
+description: "== FEATURES/PROBLEMS:  * Pure Ruby * It's small and simple * It's probably good enough * I haven't profiled it against large data sets * Naive median implementation requires a sort, but it could be done in linear time. Patches welcome. * Missing tests for harmonic and geometric mean -- the stats package I was generating test data with didn't have them.  == SYNOPSIS:  require 'ministat'  data = [1,2,3,4,5,6,7,7,6,5,4,4] puts MiniStat::Data.new(data).to_s"
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Dean Hudson
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- bin/ministat
+- lib/ministat.rb
+- package/History.txt
+- package/Manifest.txt
+- package/README.txt
+- package/Rakefile
+- package/bin/package
+- package/lib/package.rb
+- package/test/test_package.rb
+- test/data/1.dat
+- test/data/2.dat
+- test/test_ministat.rb
+test_files: 
+- test/test_ministat.rb
+rdoc_options: 
+- --main
+- README.txt
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- package/History.txt
+- package/Manifest.txt
+- package/README.txt
+executables: 
+- ministat
+extensions: []
+
+requirements: []
+
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.3.0
+    version: