はじめに
RStudio 1.3から新機能としてlearnrパッケージによるチュートリアル機能（in-IDE tutorials）が組み込まれました。
今までもlearnrパッケージを用いればチュートリアルファイル（Rmd形式）を開いて実行することによりインタラクティブなチュートリアルを実行することができましたが、in-IDE tutorialsはファイル操作などを意識せずに実行することが可能です。インタラクティブなチュートリアルには様々な使い方が考えられますので、是非、この機能を使いこなしたいところです。
しかし、RStudio Blogなどではこの機能に対して非常に簡単にしか触れられておらず、どのようにしてチュートリアルコンテンツを追加するのかなどがよくわかりません。
そこで、in-IDE tutorials機能にチュートリアルファイルを追加する方法を調べましたので簡単に紹介します。
方法
結論から言えば、
チュートリアルファイルを含むパッケージをインストールするだけ
です。インストールされているパッケージからRStudioがチュートリアルファイルを探し出しTutorialペインに自動的にリストアップしてくれます。
つまり、チュートリアルファイルだけ（説明用のヘルプもあった方がベター）のパッケージを作成すればin-IDE tutorialsを利用することができるのです。Rのパッケージを作成するにはRStudioとpkgdownパッケージを利用すれば簡単に作成できます。
作成環境
RとRStudioが動作する環境であればパッケージ作成ができます。
| バージョンなど | 備考 | |
|---|---|---|
| R | 3.6 or later | 4.0.x 推奨 |
| RStudio | 1.3 or later | Desktop or Server |
| Package |
pkgdown, learnr, shiny, knitr, rmarkdown, tidyverse
|
作成手順
パッケージの作成はpkgdownパッケージを利用します。
- Rに必要なパッケージをインストールする
- RStudioでパッケージ作成用プロジェクトを作る
- チュートリアルファイルを所定の位置に作成する
- DESCRIPTIONファイルなどパッケージに必要なファイルを修正する
- パッケージチェクを行う
- パッケージをインストールしてチュートリアル機能を確認する
- （必要に応じて）パッケージをビルドして配布する
必要なパッケージをインストールする
以下のコマンドまたはRStudioのGUIからパッケージ作成に必要なパッケージをインストールします。
install.packages(c("pkgdown", "learnr", "shiny", "knitr", "rmarkdown", "tidyverse"))
パッケージ作成用プロジェクトを作る
RStudioのメニューから[File]-[New Project...]を選択し、開いたダイアログで[New Directory]-[R Package]の順で選択します。
Package nameとプロジェクト作成場所を入力し最後に[Create Project]ボタンをクリックすればパッケージ作成に必要なファイルやディレクトリが準備されます。
チュートリアルファイルを所定の位置に作成する
チュートリアルファイルは格納すべきディレクトリが決まっていますので、必ず指定の場所に作成します。例えばチュートリアルAとチュートリアルBの二つのチュートリアルを含んだパッケージを作成するには以下のようなディレクトリ構成にします。
.
├── DESCRIPTION
├── NAMESPACE
├── R
├── inst
│ └── tutorials
│ ├── tutorial_a
│ │ └── tutorial.Rmd
│ └── tutorial_b
│ └── tutorial.Rmd
└── man
├── tutorial_a.Rd
└── tutorial_b.Rd
チュートリアルファイル自体の作成方法についてはlearnrパッケージのドキュメントを参考にしてください。
DESCRIPTIONファイルなどパッケージに必要なファイルの記述を修正する
DESCRIPTIONファイルは正しく記述しないとパッケージのビルドができませんので注意してください。ヘルプファイル（manディレクトリ配下）はサンプルファイルが格納されていますので、それを参考に作成してください。なお、ヘルプがなくてもパッケージのビルドは可能です。
パッケージチェクを行う
必要なファイルの準備ができましたらBuildペインのメニューから[More]-[Check Package]を選んでチェックを行います。このチェックでエラーがでなければ[More]-[Clean and Rebuild]でパッケージをビルドします。
パッケージをインストールしてチュートリアル機能を確認する
パッケージのビルドが完了したらBuildペインのメニューから[Install and Restart]をクリックします。パッケージがインストールされRのセッションがリスタートします。Tutorialペインに作成したパッケージのチュートリアルがリストアップされていることを確認してください。
参考資料
パッケージの作成例をGitHubで公開していますので、詳細などはそちらでご確認ください。
CC 4.0 BY-NC-SA, Sampo Suzuki