simple_time_series 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 022c7f24717b5750931b1a724b4c501f35faa824
-  data.tar.gz: 790727d3ebc4c5f2e661cdc2c2924c1851f6303f
+  metadata.gz: b5f5ca203967d4af50f16d5afa45797faf88de47
+  data.tar.gz: 1d6b4d7b3446fd5141150054fd9bd65fb8840980
 SHA512:
-  metadata.gz: cdecc62389e5e0d65fbccf6437ad5213351310228084da6a3a955d949f462c28909cb1489f97915ab12cad6e459d74644ce644b5b4179f1c3103fb457923c2a3
-  data.tar.gz: 9be0f918259ebcde9f315eb92c5ec93dfc734decbd25defb0a3263ac3143a889f97748c417f142a4f792493aa14d370985fd7dfe24e89b533c3cd708c25d6264
+  metadata.gz: f3472c7f10c78314440774986600b67b1a00d1827abd68afae448602d1b3aec6249fbb87851f0651e2d3e2232effb6bc0e057a2da3fb044469bf531e8e4db2a5
+  data.tar.gz: c6cedd819610bcb1366e747afa536f8baea398493b5b94db1f707f5e76c040f59570163c1de75175d1b7d3e96957d01dde86d956fd32dc321a9610cad835bc00

data/README.md

@@ -173,6 +173,23 @@ 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]
 
+It also calculates cumulative sums for any data_var:
+
+    my_data.tasks_done_cumsum # returns [2, 5, 5, 19, 22, 33, 33]
+    my_data.tasks_done_cumsum[3] # returns 19
+    my_data.tasks_done_cumsum[3, 2] # returns [19, 22]
+    my_data.tasks_done_cumsum[3, 4] # returns [19, 22, 33, 33]
+    my_data.pizzas_cumsum # returns [0, 0, 1, 1, 1.5, 1.5, 3.5]
+
+    my_data.tasks_done_cumsum('Saturday') # returns 33
+    my_data.tasks_done_cumsum('Sunday') # returns 2
+    my_data.pizzas_cumsum('Saturday') # returns 3.5
+    my_data.pizzas_cumsum('2014-01-01') # returns 0
+    my_data.pizzas_cumsum('Jan 4, 2014') # returns 1
+
+    my_data.tasks_done_cumsum('Sunday','Monday') # returns [2, 5]
+    my_data.tasks_done_cumsum('Tuesday','Saturday') # returns [5, 19, 22, 33, 33]
+
 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

data/lib/simple_time_series/simple_time_series.rb

@@ -63,6 +63,17 @@ class SimpleTimeSeries
           return answer.length == 1 ? answer[0] : answer
         end
       end
+      # should DRY out variable creation, probably by passing in a strategy along with the variable name
+      define_method("#{var}_cumsum") 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)
+          sum = eval(var)[0]
+          answer = (eval(var).each_cons(2).map { |val1, val2| sum += val2 }.unshift(eval(var)[start_idx]))[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.5"
+  VERSION = "0.0.6"
 end

data/spec/lib/simple_time_series_spec.rb

@@ -202,6 +202,8 @@ describe SimpleTimeSeries 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.tasks_done_diff[3, 2].should == [14, -11]
+      @my_data.tasks_done_diff[3, 4].should == [14, -11, 8, -11]
       @my_data.pizzas_diff.should == [nil, 0, 1, -1, 0.5, -0.5, 2]
     end
 
@@ -220,4 +222,30 @@ describe SimpleTimeSeries do
 
   end
 
+  describe "#xyz_cumsum" do
+
+    it "should calculate the correct vector of cumulative sums for the referenced data_var" do
+      # @tasks_done = [2, 3, 0, 14, 3, 11, 0]
+      @my_data.tasks_done_cumsum.should == [2, 5, 5, 19, 22, 33, 33]
+      @my_data.tasks_done_cumsum[3].should == 19
+      @my_data.tasks_done_cumsum[3, 2].should == [19, 22]
+      @my_data.tasks_done_cumsum[3, 4].should == [19, 22, 33, 33]
+      @my_data.pizzas_cumsum.should == [0, 0, 1, 1, 1.5, 1.5, 3.5]
+    end
+
+    it "should let me access a single value in a vector of cumulative sums with any time_var value" do
+      @my_data.tasks_done_cumsum('Saturday').should == 33
+      @my_data.tasks_done_cumsum('Sunday').should == 2
+      @my_data.pizzas_cumsum('Saturday').should == 3.5
+      @my_data.pizzas_cumsum('2014-01-01').should == 0
+      @my_data.pizzas_cumsum('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_cumsum('Sunday','Monday').should == [2, 5]
+      @my_data.tasks_done_cumsum('Tuesday','Saturday').should == [5, 19, 22, 33, 33]
+    end
+
+  end
+
 end

metadata

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