workflowr

workflowr：RIN Rの整理 +再現性 +共有可能なデータサイエンス

ワークフローRパッケージは、研究者が効果的なプロジェクト管理、再現性、コラボレーション、および結果の共有を促進する方法で分析を整理するのに役立ちます。 Workflowrは、リテラシープログラミング（KNITRおよびRMARKDOWN）とバージョンコントロール（GIT、via git2r）を組み合わせて、タイムスタンプ、バージョン、および文書化された結果を含むWebサイトを生成します。 rユーザーは、ワークフローを迅速かつ簡単に採用できます。

詳細については、オンラインドキュメントを参照してください。たとえば、Divvy Data Exploration Projectを参照してください。 Workflowrによって促進された再現可能な研究プロジェクトを調査するには、workflowr.ioで登録されているプロジェクトを閲覧します。最新のWorkflowr開発を最新の状態に保つには、Workflowr-Announceメーリングリスト（低volume、読み取り専用）に参加してください。バグレポート、機能リクエスト、および質問については、問題を開いてください。

• 特徴
• インストール
• クイックスタート
• 帰属
• 貢献

特徴

• 整頓された
  • 組織化されたサブディレクトリを備えたプロジェクトテンプレートを提供します
  • コードと結果をR Markdownと組み合わせます
  • Gitを使用して、ソースコードと結果の両方のバージョンになります
• 再現可能
  • 各結果を作成するために使用されるコードバージョンを表示します
  • 分離されたRセッションで各分析を実行します
  • 各分析のセッション情報を記録します
  • 分析ごとに乱数生成のために同じ種子を設定します
• 共有可能
  • あなたの研究結果を提示するためのウェブサイトを作成します
  • GitHubページまたはgitlabページを介して無料でウェブサイトをホストする方法を文書
  • 過去のバージョンの結果へのリンクを作成します

WorkflowrのWebサイトが動作していることを確認するには、このビデオデモを参照してください。

関連ツールについては、R-Project-Workflowsを参照してください。

インストール

1. rをインストールします

   • （推奨）rstudioをインストールします

   • （オプション）Pandoc（手順）をインストールする

   • （オプション）gitをインストールします

2. クランからワークフローをインストールします：

   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. Getting Getting vignetteを読んで、オンラインで結果を共有する方法を学びましょう。または、再現可能な研究ワークショップビネットを読むこともできます。同じ手順をカバーしますが、ワークフルの再現性機能の一部を示すためのコードとデータのサンプルが含まれています

2. 研究Webサイトをカスタマイズする方法に関するアイデアについては、カスタマイズビネットをお読みください

3. ワークフローを既存のプロジェクトに統合する方法については、移行ビネットをお読みください

帰属

シカゴ大学のマシュー・スティーブンスの研究室のポスドク研究者であるジョン・ブリシカクによって、ワークフローが開発され、維持されています。彼は、ゴードンとベティムーア財団からMSへの助成金によって資金提供されています。ピーター・カルセントーとマシュー・スティーブンスは共著者です。

パッケージの改善を支援してくれたワークフローの寄稿者に非常に感謝しています。また、パッケージをテストし、フィードバックを提供してくれたWorkflowrユーザーにも感謝しています。特にLei Sun、Xiang Zhu、Wei Wang、およびStephens Labの他のメンバー（過去と現在）に感謝します。

Workflowrパッケージは、多くの優れたオープンソースパッケージを使用しています。このプロジェクトにとって特に重要なのは、RパッケージGIT2R、KNITR、およびRMARKDOWNです。 WorkflowrパッケージがWorkflowrを可能にするソフトウェアについて学習するためにどのように機能するかをご覧ください。

WorkflowrはMITライセンスの下で利用できます。適切な帰属については、ソフトウェアを説明する原稿を引用してください。

Blischak JD、Carbonetto P、およびStephens M.は、再現可能な研究コードの作成と共有Workflowr Way [バージョン1;ピアレビュー：3承認済み]。 F1000Research 2019、8：1749（https://doi.org/10.12688/f1000Research.20843.1）

bibtexエントリを取得するには、 citation("workflowr") 。 F1000 Researchは、元のバージョンだけでなく、改訂も公開していることに注意してください。最新バージョンを確認するには、論文のURLにアクセスしてください。

貢献

コミュニティの貢献、特にドキュメントの改善を歓迎します。開始するには、貢献ガイドラインをお読みください。また、このプロジェクトは、貢献者行動規範でリリースされていることに注意してください。このプロジェクトに参加することにより、その条件を順守することに同意します。