simple_time_series 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6f0bbac3ae67f54d62e95b9f1384a0c929261fcf
-  data.tar.gz: 0958d9d5d77ec9ec70083f6f7e3a0c6d9138b914
+  metadata.gz: 022c7f24717b5750931b1a724b4c501f35faa824
+  data.tar.gz: 790727d3ebc4c5f2e661cdc2c2924c1851f6303f
 SHA512:
-  metadata.gz: 061975cfffc0d57edcac1d7827aba80c1168bef9f63482932f47108387408af8dbbb1cfa636071f070ff2113ea6caf346904006b1c7ea4a6fde6f304dc359e77
-  data.tar.gz: 3a472b8b83c3d92be143dcb7969e4ff1c275fa64ad81ca61cf50bb8a9a8ebb8c811d816c0195e3322d1a0fa0df9947cf72a0f20d80e9cefa52647b0243698159
+  metadata.gz: cdecc62389e5e0d65fbccf6437ad5213351310228084da6a3a955d949f462c28909cb1489f97915ab12cad6e459d74644ce644b5b4179f1c3103fb457923c2a3
+  data.tar.gz: 9be0f918259ebcde9f315eb92c5ec93dfc734decbd25defb0a3263ac3143a889f97748c417f142a4f792493aa14d370985fd7dfe24e89b533c3cd708c25d6264

data/README.md

@@ -155,11 +155,29 @@ You can also set a subset of values
     my_data.pizzas_subset('2014-01-03','Jan 5, 2014') # returns [7, 8, 9.5]
     my_data.pizzas # returns [0, 0, 7, 8, 9.5, 0, 2]
 
+And you can get an array of differences between consecutive observations for any data_var:
+
+    my_data.tasks_done_diff # returns [nil, 1, -3, 14, -11, 8, -11]
+    my_data.pizzas_diff # returns [nil, 0, 1, -1, 0.5, -0.5, 2]    
+
+You can also grab subsets of these arrays of differences. It returns a single value if you request a single value:
+
+    my_data.tasks_done_diff('Saturday') # returns -11
+    my_data.tasks_done_diff('Sunday') # returns nil (because the first time slot cannot have a difference)
+    my_data.pizzas_diff('Saturday') # returns 2
+    my_data.pizzas_diff('2014-01-01') # returns nil (again, because the first time slot has no difference)
+    my_data.pizzas_diff('Jan 4, 2014') # returns -1
+
+It returns an array if you ask for a range of values:
+
+    my_data.tasks_done_diff('Sunday','Monday') # returns [nil, 1]
+    my_data.tasks_done_diff('Tuesday','Saturday') # returns [-3, 14, -11, 8, -11]
+
 Currently, SimpleTimeSeries assumes all variable arrays have equal lengths and represent the same sequence of observations. Though the gem says "time series," it should work with any kind of sequential data.
 
 ## Disclaimer
 
-This began as a simple code example for a collague who needed to do something similar. When he said he might actually use it, I decided to create this gem. But it's really simple, with very basic functionality.
+This began as a simple code example for a collague who had programmed something similar but in a manual, repetitive way with integer-indexed subscript references to rows and columns. The code worked but had become an unmaintainable, non-extensible monster. When he said he might actually use my code example, I turned it into this gem. It's really simple, with very basic functionality, but he has now started using this, so I may progressively add bells and whistles.
 
 ## Contributing
 
@@ -171,10 +189,9 @@ This began as a simple code example for a collague who needed to do something si
 
 ## Todo
 
-1. Enable generation of a difference array for any data_var
-2. Enable cumulative sum on any data_var
-3. Enable range extraction via data_var[start_time, end_time]. This currently works as data_var_subset(start_time, end_time).
-4. Enable setting values for a range via data_var[start_time, end_time]=
+1. Enable cumulative sum on any data_var
+2. Enable range extraction via data_var[start_time, end_time]. This currently works as data_var_subset(start_time, end_time).
+3. Enable setting values for a range via data_var[start_time, end_time]=
 
 ## Acknowledgements
 

data/lib/simple_time_series/simple_time_series.rb

@@ -40,7 +40,7 @@ class SimpleTimeSeries
     define_getter_and_setter(var)
     var_on = "#{var}_on"
     self.class.class_eval do
-      define_method("#{var}_subset") do |first, last|
+      define_method("#{var}_subset") do |first, last=first|
         start_idx = index_of_date_value(first)
         last_idx = index_of_date_value(last)
         (start_idx && last_idx) ? eval(var)[start_idx..last_idx] : nil
@@ -54,6 +54,15 @@ class SimpleTimeSeries
           raise "Could not run #{var}_subset with values #{val_arr}"
         end
       end
+      define_method("#{var}_diff") do |first=nil, last=nil| # should work only on numeric data
+        # this could be made more efficient by caching the full array and/or calculating only a subset of values
+        time_vars.each do |tv_key, tv_val|
+          start_idx = index_of_date_value(first) || 0
+          last_idx = index_of_date_value(last) || (first.nil? ? -1 : start_idx)
+          answer = (eval(var).each_cons(2).map { |val1, val2| val2 - val1 }.unshift(nil))[start_idx..last_idx]
+          return answer.length == 1 ? answer[0] : answer
+        end
+      end
       define_method(var_on) do |date|
         time_vars.each do |tv_key, tv_val|
           # tv_key is something like 'dows' or 'dates'

data/lib/simple_time_series/version.rb

@@ -1,3 +1,3 @@
 class SimpleTimeSeries
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/spec/lib/simple_time_series_spec.rb

@@ -161,6 +161,10 @@ describe SimpleTimeSeries do
       @my_data.pizzas_subset('Tuesday','Thursday').should == [1, 0, 0.5]
     end
 
+    it "returns the correct array subset when passed a single time_var value" do
+      @my_data.pizzas_subset('Thursday').should == [0.5]
+    end
+
     it "returns the correct array subset when passed time_var values" do
       @my_data.pizzas_subset('Tuesday','Saturday').should == [1, 0, 0.5, 0, 2]
     end
@@ -193,4 +197,27 @@ describe SimpleTimeSeries do
 
   end
 
+  describe "#xyz_diff" do
+
+    it "should calculate the correct vector of differences for the referenced data_var" do
+      @my_data.tasks_done_diff.should == [nil, 1, -3, 14, -11, 8, -11]
+      @my_data.tasks_done_diff[3].should == 14
+      @my_data.pizzas_diff.should == [nil, 0, 1, -1, 0.5, -0.5, 2]
+    end
+
+    it "should let me access a single value in a vector of differences with any time_var value" do
+      @my_data.tasks_done_diff('Saturday').should == -11
+      @my_data.tasks_done_diff('Sunday').should be_nil
+      @my_data.pizzas_diff('Saturday').should == 2
+      @my_data.pizzas_diff('2014-01-01').should be_nil
+      @my_data.pizzas_diff('Jan 4, 2014').should == -1
+    end
+
+    it "should let me access a subarray of a vector of differences with any time_var value" do
+      @my_data.tasks_done_diff('Sunday','Monday').should == [nil, 1]
+      @my_data.tasks_done_diff('Tuesday','Saturday').should == [-3, 14, -11, 8, -11]
+    end
+
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_time_series
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - James Lavin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-30 00:00:00.000000000 Z
+date: 2014-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler