correlations 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4b8dd1e7636624565004a91b5a7efb680dbce344ce8620ceac0c192ef62b2897
+  data.tar.gz: 28b4168c36cf7c7fbd821f68a41a3dc4c190ad3056dc5cc327fdad56eeddb8d7
+SHA512:
+  metadata.gz: e27d65489f767cb4c984bfe72cf562c90d7602f88c0e6722e995443e1e4bb59724e946ee2612891243ec04d8769edbbb3ff089ebce50e2a6a56cc0140b12c0f4
+  data.tar.gz: 7d2a879e7392a870e3409099222a10c98a762cdeb4b7d188fdd36f7c6bd8f198f2e299abfb090e7b8dea00262436c2b714adf0a88d5e632335f327a779214c28

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+.rspec_status
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in correlation.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    correlations (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  correlations!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Christoffer Artmann
+
+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,43 @@
+# Correlation
+
+Correlations is a gem that can be used to calculate Pearson Correlation Coefficients for a data set.
+
+## Usage
+
+Install the gem
+
+    $ gem install correlations
+
+
+Calculate the correlation between values
+
+    $ correlations weather.csv
+
+
+Correlations works on CSV files with headers.
+
+|Days with Snow|Average Temperature|Average Wind Speed|
+|--------------|:-----------------:|:----------------:|
+| 43           | 9.4               | 8.8              |
+| 25           | 9.5               | 10.5             |
+| 28           | 9.6               | 10.6             |
+| 41           | 8.8               | 9.8              |
+| 74           | 6.6               | 9.2              |
+
+It will calculate the Pearson correlation coefficient between the values in the first column and each of the other columns.
+
+    $ correlations weather.csv
+
+    Calculating correlations for data set weather.csv
+
+    Average Temperature: -0.9499166137289158
+    Average Wind Speed: -0.7059250219593274
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/artmann/correlations.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://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/correlations

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/correlations'
+require 'pathname'
+
+if ARGV.length == 0
+  puts "Filename is required"
+  exit 1
+end
+
+path = Pathname.new(ARGV[0]).realpath.to_s
+
+puts "Calculating correlations for data set #{path}"
+correlations = Correlations::Correlations.new.from_csv(path)
+
+puts ""
+correlations.keys.each do |key|
+  puts "#{key.gsub('_', ' ').gsub('-', ' ').capitalize}: #{correlations[key]}"
+end

data/correlations.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "correlations/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "correlations"
+  spec.version       = Correlations::VERSION
+  spec.authors       = ["Christoffer Artmann"]
+  spec.email         = ["christoffer@artmann.co"]
+
+  spec.summary       = "Calculate Pearson correlation coefficients"
+  spec.description   = "Command line gem for calculating Pearson correlation coefficients from data sets"
+  spec.homepage      = "https://github.com/artmann/correlations"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "bin"
+  spec.executables   = ['correlations']
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/data/glucose.csv

@@ -0,0 +1,7 @@
+age,glucose_level
+43,99
+21,65
+25,79
+42,75
+57,87
+59,81

data/data/weather.csv

@@ -0,0 +1,6 @@
+days_with_snow,average_temperature,average_wind_speed
+43,9.4,8.8
+25,9.5,10.5
+28,9.6,10.6
+41,8.8,9.8
+74,6.6,9.2

data/lib/correlations.rb

@@ -0,0 +1,32 @@
+require 'csv'
+require_relative "./correlations/version"
+
+module Correlations
+  class Correlations
+    def from_csv(path)
+
+      raw = File.read(path)
+
+      data = CSV.parse(raw, headers: true).map(&:to_h)
+
+      sample_size = data.size
+      primary_key = data.first.keys.first
+      correlations = {}
+      
+      data.first.keys.reject { |k| k == primary_key }.each do |key|
+        x = data.map { |r| r[primary_key] }.map(&:to_f)
+        y = data.map { |r| r[key] }.map(&:to_f)
+        xx = x.map { |x| x ** 2 }.sum
+        yy = y.map { |y| y ** 2 }.sum
+        xy = x.each_with_index.map { |x, i| x * y[i] }.sum
+        
+        a = (sample_size * xy - x.sum * y.sum)
+        b = Math.sqrt((sample_size * xx - x.sum ** 2) * (sample_size * yy - y.sum ** 2))
+        
+        correlations[key] = a / b
+      end
+      
+      return correlations
+    end
+  end
+end

data/lib/correlations/version.rb

@@ -0,0 +1,3 @@
+module Correlations
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: correlations
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Christoffer Artmann
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-08-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Command line gem for calculating Pearson correlation coefficients from
+  data sets
+email:
+- christoffer@artmann.co
+executables:
+- correlations
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/correlations
+- correlations.gemspec
+- data/glucose.csv
+- data/weather.csv
+- lib/correlations.rb
+- lib/correlations/version.rb
+homepage: https://github.com/artmann/correlations
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Calculate Pearson correlation coefficients
+test_files: []