2010/09/07

RubyからRを使うRinRubyを試してみた

Ruby から R へアクセスできる RinRuby について日本語の文章があまりないみたいなので書く。

今回の環境は僕が常用している Mac OS X 10.6.4 と R 2.11.1, Ruby 1.9.2, RubyGems 1.3.7です。Ruby 1.8系でも動きそうですが、まさか、まだ 1.8 系使っているとか、ありえないですよねー、まさかねー。

まず RinRuby をインストールするよ。
[code]
sudo gem install rinruby
[/code]

すごく簡単。適当にあることないことコードを書く。

[ruby]
#!/usr/bin/env ruby

require 'rubygems'
require 'rinruby'
require 'pp'

sample_size = 100
hist_file = "/Users/itoshi/Projects/rinruby/hist.png"

# うざいメッセージを止める
R.echo(enable = false)

# pull メソッドで R コードの実行結果を受けとる
R.x = R.pull "rnorm(#{sample_size})"

# 関数も問題なく使える
R.x_sum = R.pull "sum(x)"
R.x_sd = R.pull "sd(x)"

# Ruby で出力する
puts R.x_sum
puts R.x_sd

# 関数のように数行のときはヒアドキュメントを使う
R.eval <<EOF
myfactorial <- function(n) {
if (n <= 1)
return(1)
else
return( n * Recall(n-1) )
}
fac <- myfactorial(#{sample_size})
EOF

# Rでは fac という変数は、Ruby からは R.fac でアクセスできる
puts R.fac

# plot もできる
# export DISPLAY=localhost:0.0 して X11 の起動を忘れずに (Mac)
R.eval <<EOF
png("#{hist_file}")
hist(x)
dev.off()
EOF
[/ruby]

ローカルに hist.png ができているはず。

さてどういう仕組みになっているのだろうか? RinRuby インスタンスを除いてみよう。
[ruby]
irb(main):001:0> require "rinruby"
=> true
irb(main):002:0> require "pp"
=> true
irb(main):003:0> pp RinRuby.new
#<RinRuby:0x00000100a58380
@echo_enabled=true,
@echo_stderr=false,
@engine=#<IO:fd 18>,
@executable="R",
@hostname="127.0.0.1",
@interactive=true,
@opts=
{:echo=>true,
:interactive=>true,
:executable=>nil,
:port_number=>38442,
:port_width=>1000,
:hostname=>"127.0.0.1"},
@platform="default",
@port_number=39093,
@port_width=1000,
@reader=#<IO:fd 18>,
@readline="constant",
@server_socket=#<TCPServer:fd 15>,
@socket=#<TCPSocket:fd 16>,
@writer=#<IO:fd 18>>
=> #<RinRuby:0x00000100a58380 @opts={:echo=>true, :interactive=>true, :executable=>nil, :port_number=>38442, :port_width=>1000, :hostname=>"127.0.0.1"}, @port_width=1000, @executable="R", @hostname="127.0.0.1", @port_number=39093, @server_socket=#<TCPServer:fd 15>, @echo_enabled=true, @echo_stderr=false, @interactive=true, @platform="default", @readline="constant", @engine=#<IO:fd 18>, @reader=#<IO:fd 18>, @writer=#<IO:fd 18>, @socket=#<TCPSocket:fd 16>>
[/ruby]

なにやら TCP という怪しい文字列が! RinRuby は 800行程度の Pure Ruby で書かれているようです。のぞいてみましょう。どきどき。

RinRuby のコンストラク部分の抜粋です。
[ruby]
while true
begin
@port_number = @opts[:port_number] + rand(port_width)
@server_socket = TCPServer::new(@hostname, @port_number)
break
rescue Errno::EADDRINUSE
sleep 0.5 if port_width == 1
end
end
@echo_enabled = @opts[:echo]
@echo_stderr = false
@interactive = @opts[:interactive]
@platform = case RUBY_PLATFORM
when /mswin/ then 'windows'
when /mingw/ then 'windows'
when /bccwin/ then 'windows'
when /cygwin/ then 'windows-cygwin'
when /java/
require 'java' #:nodoc:
if java.lang.System.getProperty("os.name") =~ /[Ww]indows/
'windows-java'
else
'default-java'
end
else 'default'
end
if @executable == nil
@executable = ( @platform =~ /windows/ ) ? find_R_on_windows(@platform =~ /cygwin/) : 'R'
end
platform_options = []
if ( @interactive )
begin
require 'readline'
rescue LoadError
end
@readline = defined?(Readline)
platform_options << ( ( @platform =~ /windows/ ) ? '--ess' : '--interactive' )
else
@readline = false
end
cmd = %Q<#{executable} #{platform_options.join(' ')} --slave>
@engine = IO.popen(cmd,"w+")
@reader = @engine
@writer = @engine
raise "Engine closed" if @engine.closed?
@writer.puts <<-EOF
#{RinRuby_KeepTrying_Variable} <- TRUE
while ( #{RinRuby_KeepTrying_Variable} ) {
#{RinRuby_Socket} <- try(suppressWarnings(socketConnection("#{@hostname}", #{@port_number}, blocking=TRUE, open="rb")),TRUE)
if ( inherits(#{RinRuby_Socket},"try-error") ) {
Sys.sleep(0.1)
} else {
#{RinRuby_KeepTrying_Variable} <- FALSE
}
}
rm(#{RinRuby_KeepTrying_Variable})
EOF
r_rinruby_get_value
r_rinruby_pull
r_rinruby_parseable
@socket = @server_socket.accept
echo(nil,true) if @platform =~ /.*-java/ # Redirect error messages on the Java platform
[/ruby]

Rの起動は、IO.popen, つまりOSのパイプで、Ruby と Rのデータのやり取りは TCP/IPストリーム型接続で行うという面白い仕組みになっています。始めにソケットを用意しています (4行目)。次に、プラットフォームごとに、Rを起動するコマンドを生成してパイプで開いていますね (13-42)。最後に @server_socket.accept で接続を受けとっています。Ruby がサーバ、Rがクライアントということです。

RSRuby など、RとタイトカップリングしているCコードだとメンテが大変で、Windows とか提供されてないよね。だからこういう仕組みにしたんだよ、というのが作者の主張のようです。RinRubyの論文はこちら (PDF)

History.txt をみると Ruby 1.9 への対応がされていたり、最終更新日が2010/05/01 だったりとちゃんとメンテされているっぽいですね。

まとめ


インストールも簡単だし、使い方もそんなに難しくないね。ちょこっとR側の関数を使いたいときに気軽に使えそうな予感。ただ、Ruby 書いているのに、= が <- になるバグが頻出するw

あれ、気付いたら R package じゃなくて Ruby 読んでたわw 連載のほうもぼちぼちのんびりペースでアップしていきます。