byar 0.0.1 → 0.1.0

data/lib/byar.rb

@@ -1,13 +1,102 @@
+##
+# Byar is a Byar's approximation confidence interval tool with SMR calculation.
+#
+# Can be used with class-level methods or as instantiated object.
+#
+# Class-level example with observed value 100 and expected value 90:
+#
+#   Byar.upper(100, 90) # => 1.3514260807978444, equals to SMR of 135.1
+#
+# Object instance example with observed value 100 and expected value 90:
+#
+#   b = Byar.new(100)
+#   b.upper_bound # => 121.628347271806
+#   b.lower(90) # => 0.9040199067337297, equals to SMR of 90.4
+#
 class Byar
+  ##
+  # Z_VALUE defaults to 1.96 for 95% confidence interval
+  #
+  Z_VALUE = 1.96
+  
+  attr_writer :z_value
+  
+  ##
+  # Create new Byar approximation calculator for +obs+ observed cases
+  def initialize(obs)
+    @obs = obs
+  end
+  
+  ##
+  # Calculate SMR-like lower boundary (1 equals SMR of 100)
+  # 
+  # Give +obs+ observed and +exp+ expected values to return a lower SMR-like
+  # boundary value (0 - Infinite)
   def self.lower(obs, exp)
     return nil if exp == 0
-    return 0 if obs == 0
-    obs.quo(exp) * (1 - 1.quo(9 * obs) - 1.96.quo(3 * Math.sqrt(obs))) ** 3
+    lower_bound(obs).quo(exp)
   end
   
+  ##
+  # Calculate SMR-like upper boundary (1 equals SMR of 100)
+  #
+  # Give +obs+ observed and +exp+ expected values to return an upper SMR-like
+  # boundary value (0 - Infinite)
   def self.upper(obs, exp)
     return nil if exp == 0
+    upper_bound(obs).quo(exp)
+  end
+  
+  ##
+  # Calculate lower boundary for observed cases
+  def self.lower_bound(obs)
+    return 0 if obs == 0
+    obs * (1 - 1.quo(9 * obs) - Z_VALUE.quo(3 * Math.sqrt(obs))) ** 3
+  end
+  
+  ##
+  # Calculate upper boundary for observed cases
+  def self.upper_bound(obs)
     obs = obs + 1
-    (obs).quo(exp) * (1 - 1.quo(9 * (obs)) + 1.96.quo(3 * Math.sqrt(obs))) ** 3
+    obs * (1 - 1.quo(9 * obs) + Z_VALUE.quo(3 * Math.sqrt(obs))) ** 3
+  end
+
+  def self.z_value=(value)
+    @z_value = value
+  end
+  
+  def self.z_value
+    @z_value ||= Z_VALUE
+  end
+  
+  ##
+  # Give lower SMR-like boundary for +expected+ cases
+  def lower(expected)
+    self.class.lower(@obs, expected)
+  end
+  
+  ##
+  # Give upper SMR-like boundary for +expected+ cases
+  def upper(expected)
+    self.class.upper(@obs, expected)
+  end
+  
+  ##
+  # Give lower boundary for observed value
+  def lower_bound
+    self.class.lower_bound(@obs)
+  end
+  
+  ##
+  # Give upper boundary for observed value
+  def upper_bound
+    self.class.upper_bound(@obs)
   end
+  
+  ##
+  # Give object's Z value, with fallback to Class variable or Z_VALUE
+  def z_value
+    @z_value ||= self.class.z_value
+  end
+  
 end

metadata

@@ -1,54 +1,45 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: byar
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.1.0
   prerelease: 
-  version: 0.0.1
 platform: ruby
-authors: 
+authors:
 - Floris Huetink
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-09-02 00:00:00 Z
+date: 2012-10-29 00:00:00.000000000 Z
 dependencies: []
-
 description: Byar's approximation for use in (H)SMR calculations
 email: floris@avocado.nl
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - lib/byar.rb
 homepage: https://github.com/florish/byar
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.9.2
-required_rubygems_version: !ruby/object:Gem::Requirement 
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.6
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Byar's approximation
 test_files: []
-