corr 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03b5288cfbac974494e8e0a67d5f724fa4eaef2543c5e006089bc16ca3e6a820
-  data.tar.gz: 7e76dfd08e3fc42498278180359fc4b7ad6fe20f78f24131c2079a09b81186c2
+  metadata.gz: 5cabc86085a928d1055531e629a397d23c31b88e2c9fbb00196b3b87b21796f4
+  data.tar.gz: af7a67243c5dd57a9928f0847b9ef9878927256558f963ce3ce16d1d23bacae1
 SHA512:
-  metadata.gz: 148835f3be3a8f31174e3972e3758465bca1698eb45afb474c3b083ddf2041f37f0c88e092eb0a03f9a48fb1dcdd93504dff396618206bbb0af757bc6a6dd6aa
-  data.tar.gz: de7078f23afcf46da65b9fee4553e7ca47bda55f9ea540f120575ca7f96b8893dcc70cbf4ef1686e042ad6c744891f9c7f21a5bad153062ddac661299503a25d
+  metadata.gz: e701a4c17e8624fe867820923d129e00661f28c52e644987272c4aeb6cde710107917d3480cfbc618928731232d471c240b385797b25b68c94b084b12f89c927
+  data.tar.gz: 99e846107e2644dfa35e357e6574a6a1248f20c1c6b1a8da9cca31a729778a016e39795570a75d3861dd564be9d25aa0839de69f6d98b084255dd8d49343f384

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    corr (0.2.0)
+    corr (0.3.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -22,7 +22,47 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Correlation
+
+```ruby
+x = [43, 21, 25, 42, 57, 59] # Age
+y = [99, 65, 79, 75, 87, 81] # Glucose level
+
+Corr.correlation(x, y) # 0.5298089018901745
+```
+
+### Sum
+
+```ruby
+x = [43, 21, 25, 42, 57, 59]
+
+Corr.sum(x) # 247
+```
+
+### Mean
+
+```ruby
+x = [1, 3, 2, 5, 8, 7, 12, 2, 4]
+
+Corr.mean(x) # 4.888888888888889
+```
+
+### Standard deviation
+
+```ruby
+x = [9, 2, 5, 4, 12, 7, 8, 11, 9, 3, 7, 4, 12, 5, 4, 10, 9, 6, 9, 4]
+
+Corr.standard_deviation(x) # 2.9832867780352594
+```
+
+### Covariance
+
+```ruby
+x = [2.1, 2.5, 3.6, 4.0]
+y = [8, 10, 12, 14]
+
+Corr.covariance(x, y) # 1.7
+```
 
 ## Development
 

data/corr.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = %q{Calculate the correlation of two variables}
   spec.description   = %q{This gem allows to calculate the correlation of two variables (called vectors), the standard deviation and the covariance.}
-  spec.homepage      = "https://rubygems.cor/gems/corr"
+  spec.homepage      = "https://github.com/GerryLarios/corr"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
 
   spec.metadata["homepage_uri"] = spec.homepage

data/lib/corr.rb

@@ -1,44 +1,35 @@
 require "corr/version"
 
 module Corr
-  class Formulas
-    def self.correlation(vector_x, vector_y)
-      covariance(vector_x, vector_y) / (standard_deviation(vector_x) * standard_deviation(vector_y))
-    end
+  def self.correlation(vector_x, vector_y)
+    covariance(vector_x, vector_y) / (standard_deviation(vector_x) * standard_deviation(vector_y))
+  end
 
-    def self.sum(vector)
-      vector.reduce(0.0) { |result, value| result + value }
-    end
+  def self.sum(vector)
+    vector.reduce(0.0) { |result, value| result + value }
+  end
 
-    def self.mean(vector)
-      sum(vector) / vector.length
-    end
+  def self.mean(vector)
+    sum(vector) / vector.length
+  end
 
-    def self.standard_deviation(vector)
-      vector_mean = mean(vector)
-      sum_result = vector.reduce(0.0) {|result, value| result + (value - vector_mean)**2}
-      Math.sqrt((1.0 / vector.length) * sum_result)
-    end
+  def self.standard_deviation(vector)
+    vector_mean = mean(vector)
+    sum_result = vector.reduce(0.0) {|result, value| result + (value - vector_mean)**2}
+    Math.sqrt((1.0 / vector.length) * sum_result)
+  end
 
-    def self.covariance(vector_x, vector_y)
-      if vector_x.length == vector_y.length
-        return sum_cov(vector_x, vector_y) / vector_x.length
-      else
-        raise 'The variable lengths are not the same.'
-      end
-    end
+  def self.covariance(vector_x, vector_y)
+    raise 'The variable lengths are not the same.' if vector_x.length != vector_y.length
+    sum_cov(vector_x, vector_y) / vector_x.length
+  end
 
-    private
+  private
 
-    def self.sum_cov(vector_x, vector_y)
-      n = vector_x.length
-      mean_x = mean(vector_x)
-      mean_y = mean(vector_y)
-      result = 0.0
-      for i in 0...n do
-        result += (vector_x[i] - mean_x) * (vector_y[i] - mean_y)
-      end
-      result
-    end
+  def self.sum_cov(vector_x, vector_y)
+    n = vector_x.length
+    mean_x = mean(vector_x)
+    mean_y = mean(vector_y)
+    (0...n).reduce(0.0) { |sum, i| sum + ((vector_x[i] - mean_x) * (vector_y[i] - mean_y))} 
   end
 end

data/lib/corr/version.rb

@@ -1,3 +1,3 @@
 module Corr
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: corr
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Gerardo Manuel Chavez Larios
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-06 00:00:00.000000000 Z
+date: 2020-02-11 00:00:00.000000000 Z
 dependencies: []
 description: This gem allows to calculate the correlation of two variables (called
   vectors), the standard deviation and the covariance.
@@ -18,7 +18,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".corr.gemspec.swp"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -33,10 +32,10 @@ files:
 - corr.gemspec
 - lib/corr.rb
 - lib/corr/version.rb
-homepage: https://rubygems.cor/gems/corr
+homepage: https://github.com/GerryLarios/corr
 licenses: []
 metadata:
-  homepage_uri: https://rubygems.cor/gems/corr
+  homepage_uri: https://github.com/GerryLarios/corr
 post_install_message: 
 rdoc_options: []
 require_paths: