simple_time_series 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a99423c6c3e3ef3717c741f6c62a8f6b7d432140
-  data.tar.gz: 94125e0737e9353a24c0e81ce75cd9c226742bde
+  metadata.gz: 6f0bbac3ae67f54d62e95b9f1384a0c929261fcf
+  data.tar.gz: 0958d9d5d77ec9ec70083f6f7e3a0c6d9138b914
 SHA512:
-  metadata.gz: 87f4f7d17a23a0eb793483b4864913d7319ffdd4675706c2b9899d262b854977e63263cb422928f80e4ab865e97b072cb57f96b64c32a4d8e5204fe08f033e5c
-  data.tar.gz: 1b6cfeab601d9fb0e70e7a44ddba59c1a378ea76f5e09d845b3ae38799cb45a6ab0963665f62b86d69f8e79321dda06e20c4c30ae40faff6f0e810a64aaedeff
+  metadata.gz: 061975cfffc0d57edcac1d7827aba80c1168bef9f63482932f47108387408af8dbbb1cfa636071f070ff2113ea6caf346904006b1c7ea4a6fde6f304dc359e77
+  data.tar.gz: 3a472b8b83c3d92be143dcb7969e4ff1c275fa64ad81ca61cf50bb8a9a8ebb8c811d816c0195e3322d1a0fa0df9947cf72a0f20d80e9cefa52647b0243698159

data/README.md

@@ -138,6 +138,23 @@ You can create new time and data variables and use them together:
     puts my_data.hours_of_tv_on('Fri') # prints 6.5
     puts my_data.hours_of_tv_on('Sun') # prints 7
 
+You can extract a subset of any data variable by using any time variable values as indexes for the first and last elements you want in your subset:
+
+    my_data.pizzas_subset('Tuesday','Thursday') # returns [1, 0, 0.5]
+    my_data.tasks_done_subset('Jan 2, 2014','Jan 5, 2014') # returns [3, 0, 14, 3]
+
+You can even mix different time variables together:
+
+    my_data.tasks_done_subset('Monday','Jan 5, 2014') # returns [3, 0, 14, 3]
+    my_data.pizzas_subset('Jan 1, 2014','2014-01-04') # returns [0, 0, 1, 0]
+
+You can also set a subset of values
+
+    my_data.pizzas_subset_set('Tuesday','Thursday', [7, 8, 9.5])
+    my_data.pizzas_subset('Tuesday','Thursday') # returns [7, 8, 9.5]
+    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]
+
 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
@@ -152,6 +169,13 @@ This began as a simple code example for a collague who needed to do something si
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
 
+## 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]=
+
 ## Acknowledgements
 
 Thanks to my employer, Hedgeye, for letting me create and publish this.

data/lib/simple_time_series/simple_time_series.rb

@@ -40,6 +40,20 @@ class SimpleTimeSeries
     define_getter_and_setter(var)
     var_on = "#{var}_on"
     self.class.class_eval do
+      define_method("#{var}_subset") do |first, last|
+        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
+      end
+      define_method("#{var}_subset_set") do |first, last, val_arr|
+        start_idx = index_of_date_value(first)
+        last_idx = index_of_date_value(last)
+        if (start_idx && last_idx)
+          eval(var)[start_idx..last_idx] = val_arr
+        else
+          raise "Could not run #{var}_subset with values #{val_arr}"
+        end
+      end
       define_method(var_on) do |date|
         time_vars.each do |tv_key, tv_val|
           # tv_key is something like 'dows' or 'dates'
@@ -51,6 +65,9 @@ class SimpleTimeSeries
     end
     instance_variable_set("@#{var}", vals) if vals
     data_vars[var] = vals unless data_vars.has_key?(var)
+    #def eval(var).[] (first, last)
+    #  send "#{var}_subset".to_sym, first, last
+    #end
   end
 
   private

data/lib/simple_time_series/version.rb

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

data/spec/lib/simple_time_series_spec.rb

@@ -143,4 +143,54 @@ describe SimpleTimeSeries do
 
   end
 
+  describe "#[,]" do
+
+    it "returns the correct array subset when passed index values" do
+      @my_data.pizzas[1,4].should == @pizzas[1,4]
+    end
+
+    #it "returns the correct array subset when passed index values" do
+    #  @my_data.miles['2014-01-03','Saturday'].should = [0.0, 4.3, 1.2, 12.2, 2.3]
+    #end
+
+  end
+
+  describe "#xyz_subset" do
+
+    it "returns the correct array subset when passed time_var values" do
+      @my_data.pizzas_subset('Tuesday','Thursday').should == [1, 0, 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
+
+    it "returns the correct array subset when passed time_var values" do
+      @my_data.pizzas_subset('2014-01-03','2014-01-07').should == [1, 0, 0.5, 0, 2]
+    end
+
+    it "returns the correct array subset when passed time_var values" do
+      @my_data.tasks_done_subset('Jan 2, 2014','Jan 5, 2014').should == [3, 0, 14, 3]
+      @my_data.pizzas_subset('Jan 1, 2014','Jan 4, 2014').should == [0, 0, 1, 0]
+    end
+
+    it "returns the correct array subset when passed a mix of time_var types" do
+      @my_data.tasks_done_subset('Monday','Jan 5, 2014').should == [3, 0, 14, 3]
+      @my_data.pizzas_subset('Jan 1, 2014','2014-01-04').should == [0, 0, 1, 0]
+    end
+
+  end
+
+  describe "#xyz_subset_set" do
+
+    it "returns the correct array subset when passed time_var values" do
+      @my_data.pizzas_subset('Tuesday','Thursday').should == [1, 0, 0.5]
+      @my_data.pizzas_subset_set('Tuesday','Thursday', [7, 8, 9.5])
+      @my_data.pizzas_subset('Tuesday','Thursday').should == [7, 8, 9.5]
+      @my_data.pizzas_subset('2014-01-03','Jan 5, 2014').should == [7, 8, 9.5]
+      @my_data.pizzas.should == [0, 0, 7, 8, 9.5, 0, 2]
+    end
+
+  end
+
 end

metadata

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