vr_12_score 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0e650a4cb7490c1fba739a0ce2ddd6602737f95f
+  data.tar.gz: 90281394a78b1766d0f706fba13118658593b3d4
+SHA512:
+  metadata.gz: 568a46370d1fb631856c7eaa99c4f8bd192c35b22a6df12ee41321cc9018f0519e4f5fbdc1f0cd365a8d380614c379f62c421be82e13bf48372d22eb840e60a5
+  data.tar.gz: d853941687edb5bee03adbeb211d87a857ad3bc4c54f59e27f141ecd98d52f9fd570d92b722b3b9666948696cdbd63edf20788ce55118da69b4324fd51d00012

data/lib/vr_12_score.rb

@@ -0,0 +1,147 @@
+require 'csv'
+
+# @author Kevin Spevak
+class Vr12Score
+  QUESTION_LABELS = [:gh1, :pf02, :pf04, :vrp2, :vrp3, :vre2, :vre3, :bp2, :mh3, :vt2, :mh4, :sf2]
+
+  # @return [String] The directory of the csv files containing the weights used to score the vr-12 survey.
+  attr_accessor :weights_dir
+
+  # @return [String] The name of the file containing weights for calculating the physical component
+  #   score for a vr-12 survey administered by phone. Defaults to "pcs_phone.csv"
+  attr_accessor :pcs_phone_file
+
+  # @return [String] The name of the file containing weights for calculating the mental component
+  #   score for a vr-12 survey administered by phone. Defaults to "mcs_phone.csv"
+  attr_accessor :mcs_phone_file
+
+  # @return [String] The name of the file containing weights for calculating the physical component
+  #   score for a mail-out vr-12 survey. Defaults to "pcs_mail.csv"
+  attr_accessor :pcs_mail_file
+
+  # @return [String] The name of the file containing weights for calculating the mental component
+  #   score for a mail-out vr-12 survey. Defaults to "mcs_mail.csv"
+  attr_accessor :mcs_mail_file
+
+  # @param weights_dir [String] ("weights") The directory of the csv files containing the weights used
+  #   to score the vr-12 survey.
+  def initialize(weights_dir="weights")
+    @weights_dir    = weights_dir
+    @pcs_phone_file = "pcs_phone.csv"
+    @mcs_phone_file = "mcs_phone.csv"
+    @pcs_mail_file  = "pcs_mail.csv"
+    @mcs_mail_file  = "mcs_mail.csv"
+  end
+
+  # Calculates the score for a response to the vr-12 survey
+  # @param survey [Hash] The survey response data.  This argument must contain 13 keys: One for each of
+  #   the 12 questions in the vr-12 survey, and a :type key.
+  # @option survey [String] :type The method that was used to administer this survey. "phone" or "mail"
+  # @option survey [Number] :gh1 The response to question 1: General Health (1-5)
+  # @option survey [Number] :pf02 The response to question 2a: Physical Functioning part a (1-3)
+  # @option survey [Number] :pf04 The response to question 2b: Physical Functioning part b (1-3)
+  # @option survey [Number] :vrp2 The response to question 3a: Physical Work Limitations part a (1-5)
+  # @option survey [Number] :vrp3 The response to question 3b: Physical Work Limitations part b (1-5)
+  # @option survey [Number] :vre2 The response to question 4a: Emotional Work Limitations part a (1-5)
+  # @option survey [Number] :vre3 The response to question 4b: Emotional Work Limitations part b (1-5)
+  # @option survey [Number] :bp2 The response to question 5: Bodily Pain (1-5)
+  # @option survey [Number] :mh3 The response to question 6a: Mental Health - Peaceful (1-6)
+  # @option survey [Number] :vt2 The response to question 6b: Vitality - Energy (1-6)
+  # @option survey [Number] :mh4 The response to question 6c: Mental Health - Down (1-6)
+  # @option survey [Number] :sf2 The response to question 7: Social Functioning (1-5)
+  # @return [Hash{Symbol => Number}] The physical component score and mental component score.
+  def score(survey)
+    if !survey || !survey.is_a?(Hash)
+      raise ArgumentError.new("requires a hash of survey data")
+    end
+    if (QUESTION_LABELS - survey.keys).length > 0
+      raise ArgumentError.new("Survey data missing keys for questions #{QUESTION_LABELS - survey.keys}")
+    end
+    non_numeric_labels = QUESTION_LABELS.select {|q| !(survey[q].nil? || survey[q].is_a?(Numeric))}
+    if non_numeric_labels.length > 0
+      raise ArgumentError.new("Values for questions #{non_numeric_labels} must be numeric or nil.")
+    end
+    if survey[:type] == "phone"
+      pcs_data = pcs_phone_data
+      mcs_data = mcs_phone_data
+    elsif survey[:type] == "mail"
+      pcs_data = pcs_mail_data
+      mcs_data = mcs_mail_data
+    else
+      raise ArgumentError.new('Survey data must include a type that is either "phone" or "mail"')
+    end
+
+    # Convert answers to 0-100 scale values
+    survey[:gh1] = case survey[:gh1]
+                   when nil then nil
+                   when 1 then 100
+                   when 2 then 85
+                   when 3 then 60
+                   when 4 then 35
+                   when 5 then 0
+                   else raise ArgumentError.new("Value for :gh1 must be an integer from 1 to 5")
+    end
+    blank_questions = QUESTION_LABELS.select {|q| survey[q].nil?}
+    ([:pf02, :pf04] - blank_questions).each do |q|
+      raise ArgumentError.new("Value for #{q} must be an integer from 1 to 3") unless [1, 2, 3].include? survey[q]
+      survey[q] = (survey[q] - 1) * 50
+    end
+    ([:vrp2, :vrp3, :vre2, :vre3, :bp2, :sf2] - blank_questions).each do |q|
+      raise ArgumentError.new("Value for #{q} must be an integer from 1 to 5") unless (1..5).to_a.include? survey[q]
+      survey[q] = (5 - survey[q]) * 25
+    end
+    survey[:sf2] = 100 - survey[:sf2] if survey[:sf2]
+    ([:mh3, :vt2, :mh4] - blank_questions).each do |q|
+      raise ArgumentError.new("Value for #{q} must be an integer from 1 to 6") unless (1..6).to_a.include? survey[q]
+      survey[q] = (6 - survey[q]) * 20
+    end
+    survey[:mh4] = 100 - survey[:mh4] if survey[:mh4]
+
+    # Find key to look up question weights based on blank questions
+    key = 0
+    blank_questions.each {|q| key |= 1 << QUESTION_LABELS.reverse.index(q)}
+
+    pcs_row = pcs_data[:key].index(key)
+    mcs_row = mcs_data[:key].index(key)
+
+    pcs = mcs = nil
+    if pcs_row
+      pcs_weights = pcs_data[pcs_row]
+      # Calculate score by taking the weighted sum of the question responses given the appropriate weights,
+      # then adding the appropriate constant term, based on which questions were answered.
+      # Convert survey answers to integers to handle nil values (will not affect the weighted sum)
+      # Add 'x' to end of question labels to look up weights to match the headers of the weight files.
+      pcs = QUESTION_LABELS.map {|q| survey[q].to_i * pcs_weights[weight_name(q)]}.reduce(&:+) + pcs_weights[:cons]
+    end
+
+    if mcs_row
+      mcs_weights = mcs_data[mcs_row]
+      mcs = QUESTION_LABELS.map {|q| survey[q].to_i * mcs_weights[weight_name(q)]}.reduce(&:+) + mcs_weights[:cons]
+    end
+
+    return {pcs: pcs, mcs: mcs}
+  end
+
+  private
+
+  # Convert question label to name of corresponding column in weights file
+  def weight_name(question_label)
+    (question_label.to_s.sub(/^vr/, "r") + "x").to_sym
+  end
+
+  def pcs_phone_data
+    @pcs_phone_data ||= CSV.table(File.join(@weights_dir, @pcs_phone_file))
+  end
+
+  def mcs_phone_data
+    @mcs_phone_data ||= CSV.table(File.join(@weights_dir, @mcs_phone_file))
+  end
+
+  def pcs_mail_data
+    @pcs_mail_data ||= CSV.table(File.join(@weights_dir, @pcs_mail_file))
+  end
+
+  def mcs_mail_data
+    @mcs_mail_data ||= CSV.table(File.join(@weights_dir, @mcs_mail_file))
+  end
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: vr_12_score
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Trainer Rx
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: A utility for calculating the VR-12 Physical Component Score (PCS) and
+  Mental Component Score (MCS)
+email: dev.support@trainer-rx.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/vr_12_score.rb
+homepage: https://github.com/trainer-rx/vr_12_score
+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.2.2
+signing_key: 
+specification_version: 4
+summary: VR-12 scoring tool
+test_files: []