summarytools 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 424eda8fd2e96a78b71bfcb9b3a5bd72d06ec28a
+  data.tar.gz: b199639dcbdc981f6e29c8e1e61a66bffe57922d
+SHA512:
+  metadata.gz: 22e9f124256b7ff21e4389afb85b08717e8545517a96eaec2f9e7c5f5e5d616ab97985ec3f1d3fa5ec8517718d091ce79d32af24640d9f3c15ab842490381ffc
+  data.tar.gz: 5b1d1b46330dc0e4e441ad2efeda438596e200834db235cf518fa7e49bc8a8661f55d91a3d21355a880fd7d0a067e52eb9784653b1d894b03ac2d800e62e555f

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 plutonbacon
+
+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,4 @@
+# summarytools
+
+A pure Ruby port of Dominic Comtois' excellent 
+[R package](https://github.com/dcomtois/summarytools) with the same name.

data/lib/summarytools.rb

@@ -0,0 +1,18 @@
+require 'summarytools/version'
+require 'summarytools/core_extensions/enumerable'
+require 'summarytools/describer'
+
+module SummaryTools
+  class << self
+
+    # Generates common central tendency statistics and measures of
+    # dispersion for numerical data.
+    #
+    # @return [Hash]
+    def descr(array)
+      d = Describer.new(array)
+      d.describe
+    end # def descr
+
+  end # class Self
+end # module SummaryTools

data/lib/summarytools/core_extensions/enumerable.rb

@@ -0,0 +1,4 @@
+require_relative 'enumerable/sum'
+require_relative 'enumerable/mean'
+require_relative 'enumerable/median'
+require_relative 'enumerable/sd'

data/lib/summarytools/core_extensions/enumerable/mean.rb

@@ -0,0 +1,19 @@
+unless Enumerable.method_defined? :mean
+  module Enumerable
+    # Calculates the mean of a numeric collection.
+    #
+    # @param default [Object] an optional default return value if there are
+    #   no elements. It is nil by default.
+    # @return The mean of the elements or the default value if there are no
+    #   elements.
+    #
+    # @example
+    #   [1, 2, 3, 4, 5].mean #=> 3
+    #   [].mean #=> nil
+    #   [].mean(0) #=> 0
+    def mean(default = nil)
+      coll_size = to_a.size
+      coll_size > 0 ? reduce(&:+) / coll_size.to_f : default
+    end # def mean
+  end # module Enumerable
+end

data/lib/summarytools/core_extensions/enumerable/median.rb

@@ -0,0 +1,8 @@
+unless Enumerable.method_defined? :median
+  module Enumerable
+    def median(default = nil)
+      sorted = sort
+      (sorted[(length - 1) / 2] + sorted[length / 2]) / 2.0
+    end # def median
+  end # module Enumerable
+end

data/lib/summarytools/core_extensions/enumerable/sd.rb

@@ -0,0 +1,12 @@
+unless Enumerable.method_defined? :sd
+  module Enumerable
+    def variance
+      sum = inject(0) { |accum, i| accum + (i - mean) ** 2}
+      sum/(length - 1).to_f
+    end # def variance
+
+    def sd
+      Math.sqrt(variance)
+    end # def sd
+  end # module Enumerable
+end

data/lib/summarytools/core_extensions/enumerable/sum.rb

@@ -0,0 +1,19 @@
+unless Enumerable.method_defined? :sum
+  module Enumerable
+    # Sums up elements of a collection by invoking their `+` method.
+    #
+    # @param default [Object] an optional default return value if there are
+    #   no elements. It is nil by default.
+    # @return The sum of the elements or the default value if there are no 
+    #   elements.
+    #
+    # @example
+    #   [1, 2, 3, 4, 5].sum #=> 15
+    #   ["a", "b", "c"].sum #=> "abc"
+    #   [].sum #=> nil
+    #   [].sum(0) #=> 0
+    def sum(identify = nil)
+      reduce(&:+) || default
+    end # def sum
+  end # module Enumerable
+end

data/lib/summarytools/describer.rb

@@ -0,0 +1,62 @@
+module SummaryTools
+  class Describer
+
+    attr_reader :data
+
+    private
+
+    def initialize(_data)
+      @data = _data
+    end # def initialize
+
+    def compute_kurtosis
+      fo = @data.inject(0) { |accum, x| accum + ((x - @data.mean) ** 4)}
+      fo.quo((@data.size) * @data.sd ** 4) - 3
+    end # compute_kurtosis
+
+    def compute_skewness
+      th = @data.inject(0){|a,x| a + ((x - @data.mean) ** 3)}
+      th.quo((@data.size) * @data.sd ** 3)
+    end # compute_skewness
+
+    def find_quartile(quartile)
+      sorted = @data.sort
+      return sorted.last if quartile == 4
+      # Source: http://mathworld.wolfram.com/Quartile.html
+      quartile_position = 0.25 * (quartile*sorted.length + 4 - quartile)
+      quartile_int = quartile_position.to_i
+      lower = sorted[quartile_int - 1]
+      upper = sorted[quartile_int]
+      lower + (upper - lower) * (quartile_position - quartile_int)
+    end # def find_quartile
+
+    def compute_iqr
+      return find_quartile(3) - find_quartile(1)
+    end # def compute_iqr
+
+    def compute_mad
+      absdev = []
+      data.each {|n|
+        absdev.push((n - @data.median).abs)
+      }
+      return absdev.median
+    end # def compute_mad
+
+    def describe
+      stats = {}
+      stats[:mean]       = @data.mean
+      stats[:sd]         = @data.sd
+      stats[:min]        = @data.min
+      stats[:max]        = @data.max
+      stats[:median]     = @data.median
+      stats[:mad]        = compute_mad
+      stats[:iqr]        = compute_iqr
+      stats[:cv]         = stats[:sd] / stats[:mean].abs
+      stats[:skewness]   = compute_skewness
+      stats[:kurtosis]   = compute_kurtosis
+      return stats
+    end # def describe
+
+    public(:initialize, :describe)
+  end # class Describer
+end # module SummaryTools

data/lib/summarytools/version.rb

@@ -0,0 +1,17 @@
+module SummaryTools
+  # Current major release.
+  # @return [Integer]
+  MAJOR = 1
+
+  # Current minor release.
+  # @return [Integer]
+  MINOR = 0
+
+  # Current patch level.
+  # @return [Integer]
+  PATCH = 0
+
+  # Full release version.
+  # @return [String]
+  VERSION = [MAJOR, MINOR, PATCH].join('.').freeze
+end # module SummaryTools

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: summarytools
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- plutonbacon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: 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: rubocop
+  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: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7.6
+description: 
+email:
+- plutonbacon@dynosoft.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/summarytools.rb
+- lib/summarytools/core_extensions/enumerable.rb
+- lib/summarytools/core_extensions/enumerable/mean.rb
+- lib/summarytools/core_extensions/enumerable/median.rb
+- lib/summarytools/core_extensions/enumerable/sd.rb
+- lib/summarytools/core_extensions/enumerable/sum.rb
+- lib/summarytools/describer.rb
+- lib/summarytools/version.rb
+homepage: https://github.com/plutonbacon/summarytools.rb
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: A pure Ruby port of Dominic Comtois excellent R package.
+test_files: []
+has_rdoc: