rserve-simpler 0.0.2 → 0.0.3

data/README.rdoc

@@ -18,21 +18,20 @@ the heavy lifting and should be consulted for background.
 
 === converse, convert, command
 
-These commands specify ways of talking to your Rserve connection.  All three
-allow passing names through to R in a hash.  They differ chiefly in the type
-of output you'll receive back from R.  
+These commands specify ways of talking to your Rserve connection.  They differ
+chiefly in the type of output you'll receive back from R.  
 
-    # converse: to_ruby the result
+    # converse: casts the result with 'to_ruby'
     r.converse "mean(c(1,2,3))"  # -> 2.0
 
-    # convert: Rserve::REXP result
+    # convert: returns the raw Rserve::REXP result (like eval)
     rexp = r.convert "mean(c(1,2,3))"  # -> #<Rserve::REXP::Double:0x00000002296498 @payload=[2.0], @attr=nil>
     rexp.as_doubles   # -> [2.0]
     rexp.to_ruby      # -> 2.0
 
-    # command: boolean reply if things went well
+    # command: tell R what to do and only expect boolean reply
     r.command "z <- mean(c(1,2,3))"  # -> true
-    # can retrieve variables with converse
+    # all variables are persistent in the session and can be retrieved later
     r.converse "z"  # -> 2.0
 
 converse/convert/command let you name variables in a hash as a shortcut to
@@ -48,14 +47,16 @@ converse/convert/command let you name variables in a hash as a shortcut to
 '>>' is an alias for converse, so you can write code like this:
 
     r >> "mean(c(1,2,3))"  # -> 2.0
-    # note: use '.' to get proper behavior with multiple args or blocks
+    # note: use '.>>' (and parentheses at times) to get proper behavior with multiple args or blocks
     r.>> "cor(a,b)", a: [1,2,3], b: [1,2,3]
 
 === simple DataFrame
 
-==== with a hash
+Data frames are a prominent object in R.  Simpler provides a simple ruby DataFrame object.
 
-Column names are derived from hash keys (#keys).  Ruby 1.9 hashes keep track
+==== Hash based
+
+Column names are derived from the data hash's keys.  Ruby 1.9 hashes keep track
 of insertion order.  Use an OrderedHash (gem install orderedhash) for ruby
 1.8, or set colnames.
      
@@ -75,6 +76,8 @@ of insertion order.  Use an OrderedHash (gem install orderedhash) for ruby
 
 ==== with an array of Structs
 
+The equivalent data frame as above can be generated with an array of Struct objects.
+
     DataRow = Struct.new(:var1, :fac1, :res1)
     structs = [
       DataRow.new(1,3,4),
@@ -105,15 +108,35 @@ Rserve is great for graphical output.  Here are some pointers when getting start
 
 ==== plot to screen
 
-    r.command "plot(c(1,2,3), c(3,4,5))"
+Plots to x11() are persistent until the script or session ends.
+
+Inside an irb session:
+
+    irb>>  r >> "plot(c(1,2,3), c(3,4,5))"
     # if you resize a window (at least on Ubuntu) you may need to re-issue the call
-    r.command "plot(c(1,2,3), c(3,4,5))"
+    irb>>  r >> "plot(c(1,2,3), c(3,4,5))"
     # return a list of currently used devices (device 2 is the only one being used)
     # to_ruby returns an array of 1 value as a number
-    r.converse "dev.list()" # -> 2
+    irb>>  r >> "dev.list()"
+    => 2
     # shut off graphics device 2
-    r.command "dev.off(2)"
-    r.command "graphics.off()"  # shut off all graphics
+    # [??] sometimes this generates windows 3 & 4, not sure what is happening
+    irb>> r >> "dev.off(2)"
+    # shut off all graphics
+    irb>> r >> "graphics.off()"  
+
+In a script, your plot will appear until the script exits.  This usually means
+you'll miss the display of your plot.  Two ways to deal with this:
+
+===== sleep
+
+    r >> "plot(c(1,2,3), c(4,5,6))"
+    sleep(7)  # pause for 7 seconds
+
+===== r.pause
+
+    r >> "plot(c(1,2,3), c(4,5,6))"
+    r.pause  # pauses things until a key is pressed in terminal
 
 ==== plot to file
 

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

data/lib/rserve/data_frame.rb

@@ -2,8 +2,15 @@
 module Rserve
   # An R-centric container for storing data frame-ish data
   class DataFrame
+
+    # the colnames can be set explicitly, or they will be generated by
+    # data.keys
+    attr_writer :colnames
+    # rownames as an array of Integers or Strings.  nil by default.
     attr_accessor :rownames
-    attr_accessor :hash
+    # a hash where the keys are the column names and the values are arrays of
+    # data
+    attr_accessor :data
 
     # takes an array of structs and returns a data frame object
     def self.from_structs(array)
@@ -14,14 +21,17 @@ module Rserve
           lengthwise_arrays[n][m] = val
         end
       end
-      hash = {}
+      data = {}
       names.zip(lengthwise_arrays) do |name, lengthwise_array|
-        hash[name] = lengthwise_array
+        data[name] = lengthwise_array
       end
-      self.new(hash)
+      self.new(data)
     end
 
-    def colnames() @hash.keys end
+    # will use colnames if they've been set, otherwise data.keys
+    def colnames
+      @colnames || @data.keys 
+    end
 
     # takes an ordered hash, where the col_name is the key and the data rows
     # are an array of values.  The default ordering of the hash keys will be
@@ -29,12 +39,12 @@ module Rserve
     # ordering).  Use an OrderedHash for ruby 1.8.  The rownames can be used
     # to specify the names of the rows (remains nil if no values specified)
     def initialize(ordered_hash, rownames=nil)
-      @hash = ordered_hash
+      @data = ordered_hash
       @rownames = rownames
     end
 
     def ==(other)
-      (self.hash == other.hash) && (self.rownames == other.rownames)
+      (self.data == other.data) && (self.rownames == other.rownames)
     end
   end
 

data/lib/rserve/simpler.rb

@@ -18,8 +18,8 @@ class Rserve::Simpler < Rserve::Connection
         rserve_compat_obj = 
           case obj
           when Rserve::DataFrame
-            wrapped_lists = obj.hash.values.map {|v| Rserve::REXP::Wrapper.wrap(v) }
-            z = Rserve::Rlist.new(wrapped_lists, obj.hash.keys.map(&:to_s))
+            wrapped_lists = obj.data.values.map {|v| Rserve::REXP::Wrapper.wrap(v) }
+            z = Rserve::Rlist.new(wrapped_lists, obj.colnames.map(&:to_s))
             Rserve::REXP.create_data_frame(z)
           when NArray
             obj.to_a
@@ -81,4 +81,11 @@ class Rserve::Simpler < Rserve::Connection
     (reply.size == 1) ?  reply.first : reply
   end
 
+  def pause
+    require 'curses'
+    Curses.clear
+    Curses.addstr("<< press any key when done >>")
+    Curses.getch
+  end
+
 end

data/spec/rserve/simpler_spec.rb

@@ -121,6 +121,14 @@ if RUBY_VERSION > '1.9'
       df2.rownames.is [1,2,3,4]
     end
 
+    it 'allows colnames to be set if necessary' do
+      df1 = Rserve::DataFrame.new(@hash) 
+      df1.colnames.enums [:fac1, :var1, :res1]
+      df1.colnames = %w(word to yo)
+      df1.colnames.enums %w(word to yo)
+      @r.converse(df: df1) { "names(df)" }.enums %w(word to yo)
+    end
+
     it 'converts an array of parallel structs into a dataframe' do
       df = Rserve::DataFrame.from_structs( @ar_of_structs )
       df.is @hash.to_dataframe

data/spec/rserve/test_pause_manually.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/ruby
+
+require 'rserve/simpler/R'
+require 'curses'
+
+ARGV.push(*%w(one two three))
+#ARGF.push(*%w(one two three))
+
+R >> "plot(c(1,2,3), c(1,2,3))"
+R.pause
+
+R >> "plot(c(8,9,10,11,20), c(1,2,3,0,50))"
+R.pause
+
+R >> "plot(c(8,9,10), c(1,2,3), type='l')"
+R.pause
+
+

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - John Prince
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-14 00:00:00 -07:00
+date: 2011-02-15 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -111,6 +111,7 @@ files:
 - lib/rserve/simpler/R.rb
 - rserve-simpler.gemspec
 - spec/rserve/simpler_spec.rb
+- spec/rserve/test_pause_manually.rb
 - spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/jtprince/rserve-simpler
@@ -126,7 +127,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3908836129131740135
+      hash: 3062815084109637570
       segments: 
       - 0
       version: "0"
@@ -147,4 +148,5 @@ specification_version: 3
 summary: simple interface for interacting with R through Rserve
 test_files: 
 - spec/rserve/simpler_spec.rb
+- spec/rserve/test_pause_manually.rb
 - spec/spec_helper.rb