inwt/r-base

R应用基础镜像

镜像概述和主要用途

概述：本镜像为R应用提供基础运行环境，是构建和运行R相关应用的底层支撑镜像。
主要用途：用于运行R应用程序、执行R包的标准化检查（R CMD CHECK）、运行R包测试用例，以及快速部署R脚本或包中的主函数。

核心功能和特性

• 主函数/脚本执行：支持运行导出了main函数的R包（优先级更高）或当前目录下名为main.R的脚本。
• R包检查：集成R CMD CHECK功能，可对R包进行自动化规范性检查。
• 测试运行：支持执行R包中的测试用例，验证包功能正确性。
• 卷挂载支持：通过Docker卷挂载机制，可将主机目录以只读方式映射到容器内，实现主机与容器间的文件共享。

使用场景和适用范围

• R应用开发与调试：本地开发时快速运行R脚本或包中的主函数，验证应用逻辑。
• R包质量控制：在CI/CD流程或本地环境中，通过R CMD CHECK自动化检查R包的规范性（如依赖、文档、兼容性等）。
• 测试自动化：运行R包测试用例，确保代码更新后功能稳定性。

详细使用方法和配置说明

获取帮助信息

运行以下命令可查看镜像的帮助文档：

bash
docker run inwt/[<image>]

其中 <image> 为具体镜像名称（如未指定，默认使用基础镜像）。

运行主函数或脚本

功能说明

容器优先查找并执行以下两种入口（按优先级排序）：

1. 导出了 main 函数的R包（推荐）；
2. 容器工作目录（/app/）下名为 main.R 的脚本。

使用命令

将主机目录挂载到容器内，执行主函数或脚本：

bash
docker run -v $(pwd):/:/[///</[
```bash/
```/////

## 详细使用方法

### 运行主函数或脚本
```bash
docker run/////
```////////
```bash
docker run -v $(pwd):/app/ inwt///////////
//////////
```bash
docker run -v $(pwd):/app/ inwt/[<image>] [main|]

说明：若未找到主函数或脚本，将自动显示帮助信息。

运行主函数或脚本

bash
docker run -v $(pwd):/app/ inwt/[<image>] [main|]

• -v $(pwd):/app/：将主机当前工作目录挂载到容器内的 /app/ 目录（容器内工作目录）。
• [main|]：可省略或指定 main，容器会自动检测并运行R包的main函数或main.R脚本。

R CMD CHECK 检查

功能说明

对R包执行标准化检查（如依赖完整性、文档规范性等），需将R包根目录挂载到容器内。

使用命令

bash
# 主机当前目录为R包根目录时
docker run -v $(pwd):/app/ inwt/[<image>] check

# 指定R包路径时
docker run -v <path-to-package>:/app/ inwt/[<image>] check

其中 <path-to-package> 为主机上R包的根目录路径。

测试运行

功能说明

执行R包中的测试用例，验证包功能正确性。

使用命令

bash
docker run -v $(pwd):/app/ inwt/[<image>] test

Docker命令选项说明

核心选项

• -v <host-dir>:<container-dir>:ro：卷挂载参数，将主机目录 <host-dir> 以只读方式映射到容器内 <container-dir>。
  • 示例：-v $(pwd):/app/ 表示将主机当前工作目录映射到容器内 /app/ 目录（容器工作目录），用于容器访问主机上的R包或脚本。
• （其他选项待补充）

Dockerfile说明

• 相关说明待补充，详情请关注项目更新。

贡献

如需改进本镜像文档，可访问 https://github.com/INWTlab/r-docker 进行编辑。文档编译命令如下：

bash
Rscript -e 'knitr::pandoc("README.md", format = "plain")'