workflowrで再現可能、共有可能な研究用サイト構築

workflowr

workflowrは、

• 体系化され(organized)
• 再現可能な(reproducible)
• 共有可能な（shareable)

データサイエンスのためのRパッケージです。

もう少し具体的には、

チュートリアル

Getting started with workflowr: workflowr version 1.6.0

これに沿って進めて、どんなもんか体験してみたいと思います。

その前に必要なことは、

• githubアカウントを作成する

これだけです。

このあたりは色々とウェブ上に記事があると思うのでググってください。

まずはworkflowrパッケージをインストールしてライブライで読み込んで、githubのユーザー名とメールアドレスを指定します。

library(workflowr)

# Replace the example text with your information
wflow_git_config(user.name = "xxx", user.email = "xxx@xxx.ac.jp")

次に、下記を実行してみます。すると、ResearchProjectフォルダが生成されてます。

wflow_start("ResearchProject")

プロジェクトフォルダの中身は次の図のようになっていました。

5つのフォルダがあります。

• analysis
• code
• data
• docs
• output

中身は何もいじっていない状態で、下のコードを実行してみますと

wflow_build()

View paneにサイトが表示されます。 うおおお。

もう少し近づいてみると、

Homeタブ、Aboutタブ、Lisenseタブがデフォルトで設定されています。

Homeタブのworkflowrをクリックしてみるとこんな画面が出てきて、

Home, About, Lisenceのすべてのタブの内部で、

summary
checks
past version

と3つのタブがあり、各ページのgitを通じたバージョンコントロール情報を集約させて表示してくれます。Webページ作成はworkflowrでなくてもできてしまいますが、ウェブページに自動でバージョンコントロール情報を乗せてくれるのがこのパッケージのエモいところです。普通のWebページにいちいちファイルの更新情報が細かく載っていたらうざいですが、オープンサイエンスの文脈では重要な情報になります。これまでのアドカレの記事でもあったように、研究計画をプレレジした後に変更があった場合はそれを明示して更新するなど、動的な探索的な研究では研究計画のアップデートがありえるので、いつどこで変更があったのか履歴をたどることができるのは、科学的にエモいわけです。

次のコードで、3つRmdファイルを実行して、githubに渡す準備をします。

wflow_publish(c("analysis/index.Rmd", "analysis/about.Rmd", "analysis/license.Rmd"),
              "Publish the initial files for myproject")

次に下記のコードでwflow_use_github(“xxx”)のxxxにgithubのユーザー名を指定し実行します。

wflow_use_github("xxx")

すると、コンソールに二つの選択肢が提示されますので、お好みの方、1か2を入力します。

1. githubのアカウントに自動でレポジトリ作りまっせ。
   
2. 自分でレポジトリ作ってあとでファイルを自分でアップしてな。

1. Have workflowr attempt to
automatically create the repository
"ResearchProject" on GitHub. This
requires logging into GitHub and
enabling the workflowr-oauth-app access
to the account "ytake2".

2. Create the repository
"ResearchProject" yourself by going to
https://github.com/new and entering
"ResearchProject" for the Repository
name. This is the default option.

手取り早く1を選択して見ましょう。

ふおおお、レポジトリできとる！

ただ、このままではレポジトリは空です。次の手順で、手元のprojectフォルダ内のファイルをgithubに反映(push)させます。

wflow_git_push()

コンソールでgithubのユーザー名が求められるので入力するとパスワードを入力するwindowがポップアップしてくるのでそこにパスワードを入力すると、

はい、projectフォルダに入っていたファイルがgithubに無事pushされました。

最後に、これらのファイルをGithub pageの機能を使ってウェブサイトとして表示できるようにおまじないをかけます。

ResearchProjectレポジトリーの右上にあるSetteingsをクリックしGitHub PagesのSourceがNoneとなっているところを、masterbranch/docs folderに切り替えます。

そうすると下記のようにgithub Pagesのウェブサイトのurlが表示されるので、そこをクリックするとviewerでみていたのと同じサイトが立ち上がっているのが確認できます。

こちらがウェブサイト

さて、ちゃんとバージョンコントロールの機能が機能しているかな、ということで、新規のファイルを追加してみましょう。

analysisフォルダにfirst-analysis.Rmdというファイルを追加します。

wflow_open("analysis/first-analysis.Rmd")

ついで、index.Rmdファイルに、上のファイルを追加しました、という情報を追記しておきましょう。

追加した.Rmdファイルと変更した.Rmdファイを指定し、commitコメントを適当につけます。

wflow_publish(c("analysis/index.Rmd", "analysis/first-analysis.Rmd"),
              "Add my first analysis")

後は先ほどと一緒でwflow_git_push()

最初はこの状態だったのが

バージョンコントロールの情報が追加され

アップデート、

追加が反映されました。

最高です。

このような枠組みで研究プロジェクトの計画、解析結果をバージョンコントロール情報もオープンにしながら共有していけるのはもう少し先の未来だと思っていたけど、既に現実なのですね。後は我々ユーザーがどう活用、普及していく仕組みを工夫していくか、というところでしょうか。来年、JCORSで色々と仕掛けていけるかどうかわかりませんが、国里さんはうずうずしているようですので皆様お楽しみに♪

それぞれのページの記載内容は.Rmdで編集すればOKで、Rmdで利用可能なテーマなど、デザインはある程度自由にアレンジできますので、お好みのデザインで研究プロジェクトのWebページを作成して楽しんでもらえたら良いでしょう。

Enjoy!!