Ryp 项目使用与安装指南

1. 项目的目录结构及介绍

ryp 项目是一个允许在 Python 中运行 R 代码的库。项目的目录结构如下：

ryp/
├── LICENSE           # 项目许可证文件
├── README.md         # 项目说明文件
├── pyproject.toml    # 项目配置文件
├── ryp.py            # 主 Python 模块文件
└── tests/            # 测试目录

• LICENSE: 包含项目的 MIT 许可证信息。
• README.md: 提供关于项目的详细描述、安装说明和使用示例。
• pyproject.toml: 包含项目 metadata 和依赖关系的配置文件。
• ryp.py: 包含 ryp 库的主要功能的 Python 文件。
• tests/: 包含对 ryp 库进行单元测试的代码。

2. 项目的启动文件介绍

ryp 库的主模块是 ryp.py。这个文件中定义了所有主要的函数，包括：

• r(R_code): 在 Python 中运行 R 代码。
• to_r(python_object, R_variable_name): 将 Python 对象转换为 R 对象。
• to_py(R_statement): 将 R 对象转换回 Python 对象。
• options(): 获取或设置 ryp 的配置选项。

用户可以通过导入 ryp 模块并使用这些函数来与 R 代码进行交互。

3. 项目的配置文件介绍

pyproject.toml 文件用于定义项目的元数据和依赖。以下是一个示例：

[tool.poetry]
name = "ryp"
version = "0.1.0"
description = "R inside Python"
authors = ["Your Name <[e-mail]>"]

[tool.poetry.dependencies]
python = "^3.7"
cffi = "^1.14"
pyarrow = "^3.0"

[tool.poetry.dev-dependencies]
pytest = "^6.2"

在这个配置文件中：

• name 定义了项目的名称。
• version 定义了项目的当前版本。
• description 提供了项目的简短描述。
• authors 列出了项目维护者的名字和电子邮件地址。
• dependencies 列出了项目运行时所需的依赖。
• dev-dependencies 列出了开发过程中需要的依赖，例如测试框架。

用户可以通过修改 pyproject.toml 文件来管理项目的依赖和元数据。