inwt/r-batch

R应用程序容器

本项目包含INWT项目的配置。如果您未与我们合作，可参考我们将R应用程序部署到生产环境的最佳实践。若您需要为自己的应用程序构建干净的Docker容器，请勿从此处开始：建议访问https://hub.docker.com/u/rocker/%EF%BC%88%E6%88%91%E4%BB%AC%E7%9A%84%E9%95%9C%E5%83%8F%E4%B9%9F%E6%BA%90%E4%BA%8E%E6%AD%A4%EF%BC%89%E3%80%82%E5%9C%A8%E6%AD%A4%E5%AF%B9rocker%E9%A1%B9%E7%9B%AE%E8%A1%A8%E7%A4%BA%E6%84%9F%E8%B0%A2%EF%BC%8C%E4%BD%A0%E4%BB%AC%E7%9A%84%E5%B7%A5%E4%BD%9C%E9%9D%9E%E5%B8%B8%E5%87%BA%E8%89%B2%EF%BC%81

本项目的容器可在以下位置获取：

• https://hub.docker.com/u/inwt/
• https://github.com/INWTlab/r-docker

主要镜像

r-ver-ubuntu

• 基于Ubuntu系统
• 包含特定版本的R及固定的MRAN
• 基于rocker r-ver项目构建

r-base

• 基于r-ver-ubuntu构建
• 包含基本构建工具
• 添加INWT网络设置：证书和R仓库

r-batch

• 基于r-base构建
• 添加数据库连接器（MySQL）
• 包含建模基础包（lme4、mgcv、gbm）
• 包含数据处理包（data.table、dplyr、tidyr）
• 包含自制和开源包（dbtools、mctools）

r-shiny

• 基于r-batch构建
• 添加shiny相关包（shiny、shinyjs等）

通过以下命令启动镜像：

bash
docker pull docker.xuanyuan.run/inwt/r-base:3.4.4
docker run -it docker.xuanyuan.run/inwt/r-base:3.4.4

为何使用Docker

R功能强大但缺乏标准化部署模型。Java通过JVM抽象操作系统差异，可将应用编译为可分发单元（jar）并在任何支持JVM的操作系统上运行。我们希望为R应用提供类似的分发模型：一个可执行、可测试的单元，能部署到客户环境或内部机器。

R本身稳定且跨平台，我们多年来在生产环境中无Docker也能使用R。但客户IT支持的特定操作系统选择和版本限制使我们意识到，控制应用程序的运行时环境能显著提升稳定性。

生产环境中，镜像构建后即成为"静态"单元，不会拉取更新或受代码库、包变化影响。容器应"无状态"：每个容器实例在完成单次运行后即被删除（如shiny应用会话结束或分析完成时）。每次运行应完全独立，且绝不在容器内部存储数据。

操作指南：Dockerfile与.dockerignore

Dockerfile

Docker镜像基于Dockerfile构建，该文件包含构建过程中执行的所有命令。我们通常基于上述预定义镜像构建，而非从零开始。以下是一个典型的Dockerfile示例：

dockerfile
FROM docker.xuanyuan.run/inwt/r-batch:3.4.4

ADD . .
RUN rm -vf .Rprofile && \
  installPackage

CMD ["Rscript", "inst/R_Code/someScript.R"]

• FROM：指定基础镜像
• ADD：将文件和目录复制到镜像文件系统
• RUN：执行命令（此处删除.Rprofile并安装R包，installPackage为预定义函数）
• CMD：设置容器默认行为（此处通过Rscript调用脚本）

删除.Rprofile是因为它可能覆盖容器内预配置的CRAN仓库和库路径。

更多Dockerfile指令可参考https://docs.docker.com/engine/reference/builder/%EF%BC%8C%E5%BB%BA%E8%AE%AE%E5%90%8C%E6%97%B6%E9%98%85%E8%AF%BBhttps://docs.docker.com/develop/develop-images/dockerfile_best-practices/%E3%80%82

.dockerignore

.dockerignore用于显式排除构建非必需文件，类似.Rbuildignore或.gitignore。Docker构建的第一步是将"构建上下文"复制到镜像，上下文应尽可能小以减少传输开销。详见https://docs.docker.com/engine/reference/builder/%E3%80%82

示例：

lib*
deps
largeFile.csv

构建与运行容器

使用容器需完成两步：构建镜像和启动容器。

本地开发的推荐默认命令：

bash
docker build --pull -t tmp <Dockerfile路径> && docker run --rm -it --network host tmp

详细参数说明：

bash
docker build \
    --pull \               # 尝试拉取FROM指令中镜像的新版本
    -t tmp \               # 为镜像指定标签"tmp"
    <Dockerfile路径> \     # 如"."表示当前目录
  && docker run \
    --rm \                 # 运行完成后删除容器
    -it \                  # 交互式会话，可保留在控制台中
    --network host \       # 使容器进程与主机共享IP
    tmp                    # 镜像名称（引用上述标签）

这些命令将构建镜像并执行Dockerfile中CMD定义的命令。

常用命令参考

bash
docker ps                                # 显示所有运行中的容器
docker logs <container>                  # 查看容器输出日志
docker attach <container>                # 连接到运行中的容器
docker run -it --rm <image> bash         # 在容器中启动bash（构建失败时非常有用！）
docker exec -i -t <container> /bin/bash  # 在已运行的容器中打开新的bash终端

使用场景

运行shiny应用

bash
docker build -t example-app ./examples/app
docker run --rm -p 3838:3838 docker.xuanyuan.run/example-app # 映射端口
docker run --rm --network host docker.xuanyuan.run/example-app # 共享主机网络

批处理模式运行R任务

bash
docker build -t example-batch ./examples/batch
docker run --rm docker.xuanyuan.run/example-batch # 运行默认命令
docker run --rm docker.xuanyuan.run/example-batch Rscript main.R # 运行指定脚本
docker run --rm docker.xuanyuan.run/example-batch Rscript main.R arg1 arg2 # 带参数运行脚本

生产环境应用调试

在不同环境和包版本下运行测试与R CMD检查

无需本地Dockerfile（但使用本地Dockerfile更稳定）。可将容器作为运行时环境，执行R CMD check .。-v参数用于挂载目录（卷），$PWD为当前目录，/app为容器内的工作目录。注意-v会授予写入权限！

bash
cd /path/to/your/package
docker run --rm -v $PWD:/app --user `id -u`:`id -g` docker.xuanyuan.run/inwt/r-batch:3.4.4 check
docker run --rm -v $PWD:/app --user `id -u`:`id -g` docker.xuanyuan.run/inwt/r-batch:3.5.1 check

报告