RSRuby 技术文档

1. 安装指南

RSRuby 是一个为 Ruby 开发者提供的桥接库，使得 Ruby 开发者能够访问完整的 R 统计编程环境。在开始安装之前，请确保您的系统中已经安装了 R，并且 R 是通过带有 --enable-R-shlib 选项编译的，以提供 RSRuby 所需的 R 共享库。

以下是安装 RSRuby 的步骤：

1. 确保 R_HOME 环境变量设置正确。例如：

   • 在 Ubuntu Linux 上：R_HOME=/usr/lib/R
   • 在 OS X 上：R_HOME=/Library/Frameworks/R.framework/Resources

2. 使用 setup.rb 安装包：

   ruby setup.rb config -- --with-R-dir=$R_HOME
   ruby setup.rb setup
   ruby setup.rb install
   

3. 或者，使用 gem 安装方式：

   gem install rsruby -- --with-R-dir=$R_HOME
   

如果 RSRuby 编译失败，可能需要配置 R 库的路径。以下任何一种方式都可能有效：

• 在 .bashrc（或等效文件）中添加以下行：

  export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:RHOME/bin
  

• 或者，在 /usr/local/lib 或 /usr/lib 中创建一个到 RHOME/bin/libR.so 的链接，然后运行 ldconfig。

• 或者，编辑 /etc/ld.so.conf 文件，添加以下行，然后运行 ldconfig：

  RHOME/bin
  

2. 项目的使用说明

RSRuby 使用 Singleton 设计模式，这意味着我们应该使用 instance 方法而不是 new 方法来创建 RSRuby 实例。以下是一个简单的使用示例：

# 初始化 R
require 'rsruby'

# 获取 RSRuby 实例
r = RSRuby.instance

# 调用 R 函数
data = r.rnorm(100)
r.plot(data)
sleep(2)

# 使用命名参数调用
r.plot({'x' => data, 'y' => data, 'xlab' => 'test', 'ylab' => 'test'})
sleep(2)

RSRuby 还提供了其他功能和类，如 Arrayfields、Bioconductor 库、DataFrame 类和 ERObj 类的使用示例。您可以通过查看项目分发中的示例脚本来获取更多信息。

3. 项目 API 使用文档

RSRuby 的 API 使用文档主要包含在它的手册中，该手册提供了关于调用 R 函数和转换系统的详细信息。此外，项目还提供了示例脚本来展示如何使用不同的 RSRuby 功能。

4. 项目安装方式

RSRuby 的安装方式有两种：使用 setup.rb 安装包和使用 gem 安装。以下是详细步骤：

使用 setup.rb

1. 运行配置脚本：

   ruby setup.rb config -- --with-R-dir=$R_HOME
   

2. 运行设置脚本：

   ruby setup.rb setup
   

3. 运行安装脚本：

   ruby setup.rb install
   

使用 gem

1. 运行 gem 安装命令：

   gem install rsruby -- --with-R-dir=$R_HOME
   

确保在安装过程中正确设置了 R_HOME 环境变量，以便 RSRuby 能够找到 R 的共享库。