rmageddon 0.3.1

版权所有 (c) 2018 QBiC

在此特此免费许可，任何人获得此软件及其相关文档文件（以下简称“软件”）的副本，均可不受限制地处理该软件，包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或销售软件的副本，并允许将软件提供给其他人，以便他们可以这样做，前提是遵守以下条件

上述版权声明和本许可声明应包含在软件的所有副本或主要部分中。

软件按“现状”提供，不提供任何明示或暗示的保证，包括但不限于适销性、针对特定目的的适用性和非侵权性保证。在任何情况下，作者或版权所有者均不对任何索赔、损害或其他责任承担责任，无论该责任是基于合同、侵权或其他方式，也不论该责任是否因软件或其使用或其他方式产生。

描述：# Rmageddon

[ [ [

QBiC的R分析的可重复性Docker命令行工具。

## 可重复性R分析的步骤

1. 从[模板](doc/Rmageddon-cookiecutter.md)创建项目

2. 从R sessionInfo 解决conda包

3. 根据指南[检查](doc/Rmageddon.md)项目

## 动机

使用R进行可重复分析，并与R安装环境共享必要的包及其正确版本是一项极具挑战性的任务。

为了应对这一问题，在提高计算结果可重复性的背景下，我们创建了名为Rmageddon的小型命令行工具，该工具可以帮助构建指定版本的R和版本定义的包安装的Docker容器。此外，Rmageddon还提供了cookiecutter模板，便于轻松创建用于R分析的Docker环境。

容器集合托管在另一个GitHub仓库中：[R-container-lib](https://github.com/qbicsoftware/r-container-lib)。那里所有的容器都通过了lint检查，并使用Rmageddon构建。

## 使用方法

以下图像展示了创建用于R分析的全新容器的完整工作流程


本README将引导您完成整个过程，从R分析的sessioninfo开始，最终在[我们的R-container-lib](https://github.com/qbicsoftware/r-container-lib)上分享您的Docker支持的R环境。

1. 从您的R分析中创建sessioninfo。官方R文档对此过程解释得很好：[Sessioninfo](https://www.rdocumentation.org/packages/utils/versions/3.5.2/topics/sessionInfo)。

2. 安装Rmageddon。这已在Rmageddon的文档中解释：[Rmageddon文档](doc/Rmageddon.md)

3. 使用cookiecutter模板创建Docker环境。此过程已在[Rmageddon-cookiecutter](doc/Rmageddon-cookiecutter.md)的文档中描述

4. 在您的sessioninfo上运行Rmageddon的build命令。这同样已在Rmageddon的文档中解释：[Rmageddon文档](doc/Rmageddon.md)，特别是在subcommand build部分。

5. 确保您的environment.yml文件现在或仍然位于您在步骤3中创建的R-container中

6. 将您用于分析的R脚本添加到您刚刚创建的R-container中

7. 验证您刚刚创建的R-container：运行Rmageddon的lint命令。请参阅Rmageddon的文档：[Rmageddon文档](doc/Rmageddon.md)，特别是在subcommand lint部分。

8. 如果验证成功，您的R-container现在已准备好添加到我们的R-container库。请参阅[R-container-lib](https://github.com/qbicsoftware/r-container-lib)的最终文档。

9. 祝您享受使用！

关键词：R，linting，lint，Docker，container 平台：未知