civisanalytics/civis-jupyter-r

Civis Jupyter Notebook R Docker镜像

https://circleci.com/gh/civisanalytics/civis-jupyter-r/tree/master.svg?style=svg](https://circleci.com/gh/civisanalytics/civis-jupyter-r/tree/master)

镜像概述和主要用途

该Docker镜像为R语言提供了自定义的Jupyter Notebook环境，旨在支持与Civis平台的集成，方便用户在本地进行 notebook 开发和测试，并确保环境的一致性和可重现性。

核心功能和特性

• 基于Jupyter Notebook构建，专为R语言优化
• 支持与Civis平台集成，可本地测试平台notebook
• 提供版本化标签，确保环境可重现
• 支持通过环境变量配置API密钥和平台对象ID

安装方法

本地构建镜像

bash
docker build -t civis-jupyter-r .

从DockerHub拉取镜像

bash
docker pull docker.xuanyuan.run/civisanalytics/civis-jupyter-r:latest

latest标签（未指定标签时Docker的默认值）将提供最新构建的civis-jupyter-r镜像。可将latest替换为版本号（如1.0）以获取可重现的环境。

与Civis平台集成测试

若需在本地测试镜像，请按照以下步骤操作：

1. 在Civis平台账户中创建notebook，并获取notebook ID。该ID是notebook URL末尾的数字，格式为：[***]
2. 从账户获取Civis API密钥。如何生成Civis API密钥
3. 创建名为my.env的环境文件，并添加以下内容：

   bash
   PLATFORM_OBJECT_ID=<NOTEBOOK ID>
   CIVIS_API_KEY=<您的API密钥>
   

4. 本地构建镜像：docker build -t civis-jupyter-r .
5. 运行容器：docker run --rm -p 8888:8888 --env-file my.env civis-jupyter-r
6. 通过Docker主机IP和8888端口访问notebook，即：<docker-host-ip>:8888

贡献指南

有关贡献此项目的信息，请参见CONTRIBUTING。

若进行任何更改，务必构建容器以验证其成功完成：

bash
docker build -t civis-jupyter-r:test .

并在变更日志中描述所有更改。

维护者说明

本仓库已启用自动构建。任何合并到master分支的PR将在Dockerhub上构建为latest标签。

准备创建新版本时，进入仓库的"releases"选项卡并点击"Draft a new release"。GitHub将提示创建新标签、发布标题和发布描述。标签应采用语义化版本格式"vX.X.X"（主版本.次版本.微版本）。发布标题应与标签相同。在发布描述中包含变更日志。发布标记后，DockerHub将自动构建三个相同的容器，标签分别为"major"、"major.minor"和"major.minor.micro"。

许可证

BSD-3

详见LICENSE.txt。