workflowr

WorkFlowR：有组织的 +可重现 + R的可共享数据科学

WorkFlowR R软件包可帮助研究人员以促进有效的项目管理，可重复性，协作和结果共享的方式来组织他们的分析。 WorkFlowR结合了识字编程（Knitr和RmarkDown）和版本控制（GIT，通过GIT2R）生成一个包含时间戳记，版本化和记录结果的网站。任何R用户都可以快速，轻松地采用WorkFlowR。

有关更多详细信息，请参阅在线文档。例如，请参见Divvy数据探索项目。要探索WorkFlowR促进的可重复的研究项目，请浏览WorkFlowR.IO注册的项目。要了解最新的WorkFlowR开发，请加入WorkFlowR-Announce邮件列表（小容量，仅阅读）。对于错误报告，功能请求和问题，请打开问题。

• 特征
• 安装
• 快速开始
• 归因
• 贡献

特征

• 有组织
  • 提供有组织的子目录的项目模板
  • 将代码和结果与R Markdown混合
  • 使用git来版本源代码和结果
• 可再现
  • 显示用于创建每个结果的代码版本
  • 在孤立的R会话中运行每个分析
  • 记录每个分析的会话信息
  • 为每个分析设置相同的种子以生成随机数
• 可共享
  • 创建一个网站以呈现您的研究结果
  • 文档如何通过github页面或gitlab页面免费托管您的网站
  • 创建与结果的过去版本的链接

要查看正在行动的WorkFlowR网站，请参见此视频演示。

有关相关工具，请参阅R-Project-Workflows。

安装

1. 安装r

   • （建议）安装rstudio

   • （可选）安装pandoc（说明）

   • （可选）安装git

2. 安装Cran的WorkFlowR：

   install.packages( " workflowr " )

3. 在github或gitlab上创建一个帐户

快速开始

 library("workflowr")

# Configure Git (only need to do once per computer)
wflow_git_config(user.name = "Full Name", user.email = "email@domain")

# Start a new workflowr project
wflow_start("myproject")

# Build the site
wflow_build()

# Customize your site!
#   1. Edit the R Markdown files in analysis/
#   2. Edit the theme and layout in analysis/_site.yml
#   3. Add new or copy existing R Markdown files to analysis/

# Preview your changes
wflow_build()

# Publish the site, i.e. version the source code and HTML results
wflow_publish("analysis/*", "Start my new project")

下一步：

1. 阅读完整的入门小插图，以了解如何在线分享您的结果。另外，您可以阅读可再现的研究研讨会小插图。它涵盖了相同的步骤，但包括示例代码和数据，以演示WorkFlowR的一些可重复性功能

2. 阅读自定义小插图，以获取有关如何自定义研究网站的想法

3. 阅读迁移的小插图，以将WorkFlowR集成到现有项目中

归因

WorkFlowR是由芝加哥大学Matthew Stephens实验室的博士后研究员John Blischak开发的，并得到了维持。他由Gordon和Betty Moore基金会的赠款资助。 Peter Carbonetto和Matthew Stephens是合着者。

我们非常感谢WorkFlowR贡献者帮助改善包装。我们还感谢WorkFlowR用户测试软件包并提供反馈 - 特别要感谢Stephens Lab的Lei Sun，Xiang Zhu，Wei Wang和其他成员（过去和现在）。

WorkFlowR软件包使用了许多出色的开源软件包。该项目尤其重要的是R套件Git2R，Knitr和RmarkDown。请查看Vignette WorkFlowR软件包的工作方式，以了解使WorkFlowR成为可能的软件。

WorkFlowR可根据MIT许可证获得。有关适当的归因，请引用我们描述软件的手稿：

Blischak JD，Carbonetto P和StephensM。创建和共享可重复的研究代码WorkFlowR方法[版本1;同行评审：3批准]。 F1000 Research 2019，8：1749（https：//doi.org/10.12688/f1000research.20843.1）

要获得Bibtex条目，请运行citation("workflowr") 。请注意，F1000 Research不仅发布了原始版本，还发布任何修订版。要检查最新版本，请转到纸的URL。

贡献

我们欢迎社区贡献，尤其是对文档的改进。首先，请阅读贡献指南。另外，请注意，该项目已使用贡献者的行为准则发布。通过参加该项目，您同意遵守其条款。