lite-statistics 1.0.0

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-leap-day

data/benchmarks/descriptive_statistics.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+%w[lib benchmarks].each { |name| $LOAD_PATH.unshift(name) }
+
+require 'benchmark/ips'
+require 'lite/statistics'
+require 'descriptive_statistics/safe'
+
+collection = []
+1_000_000.times { collection << rand(1..99) }
+
+puts '~~~ Default Summary Size Calculations ~~~'
+Benchmark.ips do |x|
+  x.report('lite-statistics') do
+    data = Lite::Statistics::Descriptive.new(collection)
+    data.sample_summary
+  end
+
+  x.report('descriptive_statistics') do
+    data = DescriptiveStatistics::Stats.new(collection)
+    data.descriptive_statistics
+  end
+
+  x.compare!
+end
+
+# rubocop:disable Metrics/MethodLength
+def equal_summary(data)
+  {
+    max: data.max,
+    mean: data.mean,
+    median: data.median,
+    min: data.min,
+    mode: data.mode,
+    quartile_1: data.value_from_percentile(25),
+    quartile_2: data.value_from_percentile(50),
+    quartile_3: data.value_from_percentile(75),
+    range: data.range,
+    size: data.size,
+    sum: data.sum,
+    sample_standard_deviation: data.sample_standard_deviation,
+    sample_variance: data.sample_variance
+  }
+end
+# rubocop:enable Metrics/MethodLength
+
+puts '~~~ Equal Summary Size Calculations ~~~'
+Benchmark.ips do |x|
+  x.report('lite-statistics') do
+    data = Lite::Statistics::Descriptive.new(collection)
+    equal_summary(data)
+  end
+
+  x.report('descriptive_statistics') do
+    data = DescriptiveStatistics::Stats.new(collection)
+    data.descriptive_statistics
+  end
+
+  x.compare!
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'lite/statistics'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/docs/descriptive/COEFFICIENT_OF_VARIATION.md

@@ -0,0 +1,19 @@
+# Sample|Population Coefficient of Variation
+
+Alias: `coefficient_of_variation`
+
+```ruby
+collection = [1, 1, 2, 3, 10]
+results = 0.994796148546339
+
+klass = Lite::Statistics::Descriptive.new(collection)
+klass.sample_coefficient_of_variation
+
+# - or -
+
+Lite::Statistics::Descriptive.population_coefficient_of_variation(collection)
+
+# - or -
+
+collection.sample_coefficient_of_variation
+```

data/docs/descriptive/FREQUENCIES.md

@@ -0,0 +1,22 @@
+# Frequencies
+
+```ruby
+collection = [1, 1, 2, 3, 10]
+results = {
+  1 => 2,
+  2 => 1,
+  3 => 1,
+  10 => 1
+}
+
+klass = Lite::Statistics::Descriptive.new(collection)
+klass.frequencies
+
+# - or -
+
+Lite::Statistics::Descriptive.frequencies(collection)
+
+# - or -
+
+collection.frequencies
+```

data/docs/descriptive/KURTOSIS.md

@@ -0,0 +1,19 @@
+# Sample|Population Kurtosis
+
+Alias: `kurtosis`
+
+```ruby
+collection = [1, 1, 2, 3, 10]
+results = 3.007017458066408
+
+klass = Lite::Statistics::Descriptive.new(collection)
+klass.sample_kurtosis
+
+# - or -
+
+Lite::Statistics::Descriptive.population_kurtosis(collection)
+
+# - or -
+
+collection.sample_kurtosis
+```

data/docs/descriptive/MAX.md

@@ -0,0 +1,17 @@
+# Max
+
+```ruby
+collection = [1, 1, 2, 3, 10]
+results = 10
+
+klass = Lite::Statistics::Descriptive.new(collection)
+klass.max
+
+# - or -
+
+Lite::Statistics::Descriptive.max(collection)
+
+# - or -
+
+# No monkey patch available as its part of Enumerable
+```

data/docs/descriptive/MEAN.md

@@ -0,0 +1,19 @@
+# Mean
+
+Alias: `average`
+
+```ruby
+collection = [1, 1, 2, 3, 10]
+results = 3.4
+
+klass = Lite::Statistics::Descriptive.new(collection)
+klass.mean
+
+# - or -
+
+Lite::Statistics::Descriptive.mean(collection)
+
+# - or -
+
+collection.mean
+```

data/docs/descriptive/MEDIAN.md

@@ -0,0 +1,17 @@
+# Median
+
+```ruby
+collection = [1, 1, 2, 3, 10]
+results = 2
+
+klass = Lite::Statistics::Descriptive.new(collection)
+klass.median
+
+# - or -
+
+Lite::Statistics::Descriptive.median(collection)
+
+# - or -
+
+collection.median
+```

data/docs/descriptive/MIDRANGE.md

@@ -0,0 +1,19 @@
+# Midrange
+
+Alias: `midextreme`
+
+```ruby
+collection = [1, 1, 2, 3, 10]
+results = 5.5
+
+klass = Lite::Statistics::Descriptive.new(collection)
+klass.midrange
+
+# - or -
+
+Lite::Statistics::Descriptive.midrange(collection)
+
+# - or -
+
+collection.midrange
+```

data/docs/descriptive/MIN.md

@@ -0,0 +1,17 @@
+# Min
+
+```ruby
+collection = [1, 1, 2, 3, 10]
+results = 1
+
+klass = Lite::Statistics::Descriptive.new(collection)
+klass.min
+
+# - or -
+
+Lite::Statistics::Descriptive.min(collection)
+
+# - or -
+
+# No monkey patch available as its part of Enumerable
+```

data/docs/descriptive/MODE.md

@@ -0,0 +1,17 @@
+# Mode
+
+```ruby
+collection = [1, 1, 2, 3, 10]
+results = 1
+
+klass = Lite::Statistics::Descriptive.new(collection)
+klass.mode
+
+# - or -
+
+Lite::Statistics::Descriptive.mode(collection)
+
+# - or -
+
+collection.mode
+```

data/docs/descriptive/PERCENTILE_FROM_VALUE.md

@@ -0,0 +1,19 @@
+# Percentile from Value
+
+Alias: `percentile`
+
+```ruby
+collection = [1, 1, 2, 3, 10]
+results = 80
+
+klass = Lite::Statistics::Descriptive.new(collection)
+klass.percentile_from_value(10)
+
+# - or -
+
+Lite::Statistics::Descriptive.percentile_from_value(collection, 10)
+
+# - or -
+
+collection.percentile_from_value(10)
+```

data/docs/descriptive/PROPORTIONS.md

@@ -0,0 +1,22 @@
+# Proportions
+
+```ruby
+collection = [1, 1, 2, 3, 10]
+results = {
+  1 => 0.4,
+  2 => 0.2,
+  3 => 0.2,
+  10 => 0.2
+}
+
+klass = Lite::Statistics::Descriptive.new(collection)
+klass.proportions
+
+# - or -
+
+Lite::Statistics::Descriptive.proportions(collection)
+
+# - or -
+
+collection.proportions
+```

data/docs/descriptive/RANGE.md

@@ -0,0 +1,17 @@
+# Range
+
+```ruby
+collection = [1, 1, 2, 3, 10]
+results = 9
+
+klass = Lite::Statistics::Descriptive.new(collection)
+klass.range
+
+# - or -
+
+Lite::Statistics::Descriptive.range(collection)
+
+# - or -
+
+collection.range
+```

data/docs/descriptive/SIZE.md

@@ -0,0 +1,19 @@
+# Sample|Population Size
+
+Alias: `size`
+
+```ruby
+collection = [1, 1, 2, 3, 10]
+results = 5
+
+klass = Lite::Statistics::Descriptive.new(collection)
+klass.sample_size
+
+# - or -
+
+Lite::Statistics::Descriptive.population_size(collection)
+
+# - or -
+
+collection.sample_size
+```

data/docs/descriptive/SKEWNESS.md

@@ -0,0 +1,19 @@
+# Sample|Population Skewness
+
+Alias: `skewness`
+
+```ruby
+collection = [1, 1, 2, 3, 10]
+results = 1.328592117701344
+
+klass = Lite::Statistics::Descriptive.new(collection)
+klass.sample_skewness
+
+# - or -
+
+Lite::Statistics::Descriptive.population_skewness(collection)
+
+# - or -
+
+collection.sample_skewness
+```

data/docs/descriptive/STANDARD_DEVIATION.md

@@ -0,0 +1,19 @@
+# Sample|Population Standard Deviation
+
+Alias: `standard_deviation`
+
+```ruby
+collection = [1, 1, 2, 3, 10]
+results = 3.3823069050575527
+
+klass = Lite::Statistics::Descriptive.new(collection)
+klass.sample_standard_deviation
+
+# - or -
+
+Lite::Statistics::Descriptive.population_standard_deviation(collection)
+
+# - or -
+
+collection.sample_standard_deviation
+```

data/docs/descriptive/STANDARD_ERROR.md

@@ -0,0 +1,19 @@
+# Sample|Population Standard Error
+
+Alias: `standard_error`
+
+```ruby
+collection = [1, 1, 2, 3, 10]
+results = 1.512613632095123
+
+klass = Lite::Statistics::Descriptive.new(collection)
+klass.sample_standard_error
+
+# - or -
+
+Lite::Statistics::Descriptive.population_standard_error(collection)
+
+# - or -
+
+collection.sample_standard_error
+```

data/docs/descriptive/SUM.md

@@ -0,0 +1,17 @@
+# Sum
+
+```ruby
+collection = [1, 1, 2, 3, 10]
+results = 17
+
+klass = Lite::Statistics::Descriptive.new(collection)
+klass.sum
+
+# - or -
+
+Lite::Statistics::Descriptive.sum(collection)
+
+# - or -
+
+# No monkey patch available as its part of Enumerable
+```