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。

貢獻

我們歡迎社區貢獻，尤其是對文檔的改進。首先，請閱讀貢獻指南。另外，請注意，該項目已使用貢獻者的行為準則發布。通過參加該項目，您同意遵守其條款。