statistica 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bad4ea64f4046ab9cbdbd2ac2a10b1e7a8e85cbe
-  data.tar.gz: c8ded7a27689bb515841ab4261f3f099f5ed7f81
+  metadata.gz: 56c095cfa60f020aa5c29d737ec9aba89eb45702
+  data.tar.gz: 129b22473e45e34666f6cc1f6361179ba8bd60b0
 SHA512:
-  metadata.gz: 7d1e76907844ffca9a79f812f0ca22226957e8383ac5ed732398e58b56d5b3e8a585954ab5be00d508ab911dd9a3bc6c572840b8b1b93c770a49905bffc45b43
-  data.tar.gz: 7c25a3ef337274d22f8722cb5b84495443e240b87dc836ecd4ef8b411e4ebe375d2f409a39b15b21271fe276ddae17957508b9c60f614bbfe02001afc9c04d75
+  metadata.gz: 98f11a215704c2d303f92d8d929e6ec361720273ba51401caf50583e672e1da2558e1e4a141bb81280e9e437b72e44ad524f8054691e76007edc2003c7644ed1
+  data.tar.gz: fe5359a567565f820855196f477f29038d0b1eda13f36ed1bf0a1dcf4c14a0a7e0682acf6c8f1abb45dafb7ad2258e2234e111a3e86777af1f89e0612656e4d0

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.4
+before_install: gem install bundler -v 1.13.7

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at leston_1@HOTMAIL.COM. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Tola A.
+
+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,85 @@
+# Statistica
+
+This is Statistica, a lightweight gem that is built to help in analyzing an array of number values. It arose from needing to do some descriptive statistics in one of my personal projects as well as taking on the challenge of building a framework that could be reusable in future requirements. I also feel obligated to share this as someone who has been a beneficiary of many open-source libraries/plugins/gems. Hopefully you could find a good use for this gem!
+
+##### And you are encouraged to contribute to it! 
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'statistica'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install statistica
+
+## Usage
+
+This gem is for calculation of simple descriptive statistics of a given array of values as described above. After following the installation instructions above, then the gem is ready for use.
+
+#### Methods
+
+There are 14 methods available for an array of numbers. They are:
+
+arithmetic mean           - `get_arith_mean`. 
+
+geometric mean            - `get_geo_mean`.  
+
+harmonic mean             - `get_harm_mean`.
+
+median                    - `get_median`.
+
+range                     - `get_range`.  
+
+mode                      - `get_mode`.   
+
+product                   - `get_product`.   
+
+sum                       - `get_sum`.   
+
+variance                  - `get_variance`.  
+
+standard deviation        - `get_stdev`.  
+
+percentile                - `get_percentile(n)`       (e.g. `n = 25` for 25 percentile).
+
+interquartile range       - `get_interquartile_range` (difference between 75 percentile and 25 percentile).
+
+relative variance         - `get_relative_variance`.   
+
+coefficient of variation  - `get_coeff_variation`.   
+
+#### Example
+
+Let `obj = [2, 3, 4]` be an array object. To calculate the arithmetic mean of the array object just do:
+
+`obj.get_arith_mean` 
+
+Or alternatively, 
+
+`[2, 3, 4].get_arith_mean`. 
+
+Same pattern applies to every other method available in the gem (list given above). And that's it! It's not any more complex than that.
+
+
+## Contributing
+Please submit bug reports and make pull requests at https://github.com/tab300/statistica. 
+
+##### Your contributions to make this project better in any way that you think are always welcome and appreciated. You are highly encouraged to make suggestions, corrections, or extensions.   
+
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "statistica"
+
+# 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

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/lib/fixtures.rb

@@ -0,0 +1,61 @@
+# Values to test the methods to ensure accurate calculations.
+
+def general_sample_array
+  [9, 8, 13, 9, 5, 4, 5]
+end
+
+def sum_expected
+  53
+end
+
+def product_expected
+  842400
+end
+
+def arith_mean_expected
+  7.57
+end
+
+def geo_mean_expected
+  7.02
+end
+
+def harm_mean_expected
+  6.52
+end
+
+def median_expected
+  8
+end
+
+def mode_expected
+  5
+end
+
+def range_expected
+  9
+end
+
+def variance_expected
+  9.95
+end
+
+def stdev_expected
+  3.15
+end
+
+def coeff_var_expected
+  0.42
+end
+
+def percentile_expected
+  5
+end
+
+def interquartile_range_expected
+  4
+end
+
+def relative_variance_expected
+  13.08
+end

data/lib/get_arith_mean.rb

@@ -0,0 +1,6 @@
+module Statistica
+  def get_arith_mean
+    mean = self.get_sum.to_f / self.length
+    mean.round(2)
+  end
+end

data/lib/get_coeff_variation.rb

@@ -0,0 +1,6 @@
+module Statistica
+  def get_coeff_variation
+    variation = self.get_stdev/self.get_arith_mean
+    variation.round(2)
+  end
+end

data/lib/get_geo_mean.rb

@@ -0,0 +1,6 @@
+module Statistica
+  def get_geo_mean
+    geo_mean = (self.get_product) ** (1.to_f / (self.length))
+    geo_mean.round(2)
+  end
+end

data/lib/get_harm_mean.rb

@@ -0,0 +1,7 @@
+module Statistica
+  def get_harm_mean
+    recip = self.map { |element|(1/element.to_f) }
+    harm_mean = 1/(recip.inject(:+)/self.length)
+    harm_mean.round(2)
+  end
+end

data/lib/get_interquartile_range.rb

@@ -0,0 +1,5 @@
+module Statistica
+  def get_interquartile_range
+    self.get_percentile(75) - self.get_percentile(25)
+  end
+end

data/lib/get_median.rb

@@ -0,0 +1,15 @@
+module Statistica
+  def get_median
+    # Confirm odd number of elements
+    if self.sort!.length % 2 == 1
+      median_odd = self[(self.length / 2)]
+      median_odd
+    # Confirm even number of elements
+    elsif self.sort!.length % 2 == 0
+      f_middle_element = self[(self.length / 2 - 1)]
+      s_middle_element = self[(self.length / 2)]
+      median_even = (f_middle_element + s_middle_element) / 2.0
+      median_even
+    end
+  end
+end

data/lib/get_mode.rb

@@ -0,0 +1,9 @@
+module Statistica
+  def get_mode
+    array_sort = self.sort!
+    elements = array_sort.uniq.map! { |actual_num| actual_num }
+    elements_frequency = array_sort.uniq.map! { |num| array_sort.count(num) }
+    highest_occuring_element_position = elements_frequency.index(elements_frequency.max)
+    elements.fetch(highest_occuring_element_position)
+  end
+end

data/lib/get_percentile.rb

@@ -0,0 +1,11 @@
+module Statistica
+  def get_percentile(n)
+    sorted_array = self.sort
+    percentile_index = n.to_f/100 * sorted_array.length
+    if percentile_index == percentile_index.round
+      result = (sorted_array[percentile_index.ceil - 1] + sorted_array[percentile_index.ceil])/2.to_f
+    else
+      sorted_array[percentile_index.ceil - 1]
+    end
+  end
+end

data/lib/get_product.rb

@@ -0,0 +1,5 @@
+module Statistica
+  def get_product
+    self.inject(:*)
+  end
+end

data/lib/get_range.rb

@@ -0,0 +1,5 @@
+module Statistica
+  def get_range
+    self.max - self.min
+  end
+end

data/lib/get_relative_variance.rb

@@ -0,0 +1,7 @@
+module Statistica
+  def get_relative_variance
+    var_square = (self.get_variance) ** 2
+    rel_variance = var_square/self.get_arith_mean
+    rel_variance.round(2)
+  end
+end

data/lib/get_stdev.rb

@@ -0,0 +1,6 @@
+module Statistica
+  def get_stdev
+    stdev = Math.sqrt(self.get_variance)
+    stdev.round(2)
+  end
+end

data/lib/get_sum.rb

@@ -0,0 +1,5 @@
+module Statistica
+  def get_sum
+    self.inject(:+)
+  end
+end

data/lib/get_variance.rb

@@ -0,0 +1,7 @@
+module Statistica
+  def get_variance
+    square_diff = self.map { |element| (element - self.get_arith_mean) ** 2 }
+    variance = square_diff.get_sum / (square_diff.length - 1)
+    variance.round(2)
+  end
+end

data/lib/statistica.rb

@@ -1,19 +1,19 @@
 # Running through the individual files first before prepending Array class with the parent module, Statistica
-require "./lib/statistica/version"
-require "./lib/get_sum"
-require "./lib/get_product"
-require "./lib/get_arith_mean"
-require "./lib/get_geo_mean"
-require "./lib/get_harm_mean"
-require "./lib/get_median"
-require "./lib/get_mode"
-require "./lib/get_range"
-require "./lib/get_variance"
-require "./lib/get_stdev"
-require "./lib/get_coeff_variation"
-require "./lib/get_percentile"
-require "./lib/get_interquartile_range"
-require "./lib/get_relative_variance"
+require "statistica/version"
+require "get_sum"
+require "get_product"
+require "get_arith_mean"
+require "get_geo_mean"
+require "get_harm_mean"
+require "get_median"
+require "get_mode"
+require "get_range"
+require "get_variance"
+require "get_stdev"
+require "get_coeff_variation"
+require "get_percentile"
+require "get_interquartile_range"
+require "get_relative_variance"
 
 # Prepending the Array class with the module, Statistica
 class ActivateStatistica

data/lib/statistica/version.rb

@@ -0,0 +1,3 @@
+module Statistica
+  VERSION = "0.1.3"
+end

data/statistica.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'statistica/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "statistica"
+  spec.version       = Statistica::VERSION
+  spec.authors       = ["Tola Abiola"]
+  spec.email         = "leston_1@HOTMAIL.COM"
+  spec.files         = ["lib/statistica.rb"]
+  spec.summary       = %q{A simple descriptive statistics gem.}
+  spec.description   = %q{This is a simple, easy-to-use, lightweight gem for calculating everyday
+                       descriptive statistics values.}
+  spec.homepage      = "https://github.com/tab300/Statistica"
+  spec.licenses       = ["MIT"]
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TOD: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: statistica
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Tola Abiola
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-03 00:00:00.000000000 Z
+date: 2018-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -60,7 +60,38 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/fixtures.rb
+- lib/get_arith_mean.rb
+- lib/get_coeff_variation.rb
+- lib/get_geo_mean.rb
+- lib/get_harm_mean.rb
+- lib/get_interquartile_range.rb
+- lib/get_median.rb
+- lib/get_mode.rb
+- lib/get_percentile.rb
+- lib/get_product.rb
+- lib/get_range.rb
+- lib/get_relative_variance.rb
+- lib/get_stdev.rb
+- lib/get_sum.rb
+- lib/get_variance.rb
 - lib/statistica.rb
+- lib/statistica/version.rb
+- statistica-0.1.0.gem
+- statistica-0.1.1.gem
+- statistica-0.1.2.gem
+- statistica.gemspec
 homepage: https://github.com/tab300/Statistica
 licenses:
 - MIT