/rocker

docker-rstudio

Primary LanguageRMIT LicenseMIT

R プロジェクトのひな形

Git/GitHub、Docker、RStudio、renv を利用した R プロジェクトのひな形

特徴

  • Git と GitHub
    • Git でソースコードのバージョン管理を行う
    • GitHub でソースコードをチームに共有して共同作業を行う
  • Docker と Docker Compose
    • RStudio Server の Docker コンテナイメージ rocker/rstudio を使用する
    • Linux ディストリビューションや共有ライブラリ、R のバージョンなどについて同じ環境を複数のマシン上で再現できる
    • コンテナを起動する際の設定を docker-compose.yml ファイルで管理する
    • docker compose up や docker compose down のコマンドだけで作業環境を起動・終了できる
    • Docker なしでも RStudio Desktop で動作させることは可能
  • renv
    • renv でプロジェクト固有のライブラリを作成し、依存関係を管理する
    • renv.lock ファイルでパッケージのバージョンを固定する
    • Docker ホストからパッケージキャッシュをマウントしてストレージ容量とインストール時間を改善する
  • dotfiles
    • RStudio や Git のグローバル設定ファイルを dotfiles フォルダで管理する
    • 設定ファイルを Docker ホストからコンテナにマウントして利用する
    • コンテナを停止しても設定内容が維持される
    • 複数プロジェクトのコンテナに同一の設定を反映できる
    • 同一プロジェクトでもチームメンバー個人ごとに設定をカスタマイズできる
    • GitHub を経由してマシン間で設定を同期できる

初期設定

プロジェクトの作成

このテンプレートリポジトリ terashim/rproject を元に、プロジェクトのリポジトリ（例: your-org/your-rproject）を作成する。

マシンごとの初期設定

  • Git と Docker をインストールし、GitHub へ接続できるようにしておく。
  • プロジェクトの GitHub リポジトリ（例: your-org/your-rproject）をローカル環境の適当な場所（例: ~/ghq/github.com/your-team/your-rproject）にクローンする。

作業フロー

作業環境の起動〜終了

マシン上で Docker デーモンが起動しているものとする。

  1. このディレクトリで docker compose up -d を実行することで RStudio Server の Docker コンテナを起動する
  2. ブラウザで http://localhost:8787 を開き RStudio Server に接続する
  3. RStudio Server 上でこのプロジェクトを開き、分析/開発作業を行う
  4. 作業を終了するときは、このディレクトリで docker compose down を実行することで Docker コンテナを停止する

RStudio の設定変更

  • RStudio Server 上で "Tools" > "Global Options" からカラーテーマやフォント、ペイン構成、キーボードショートカットなどの設定を変更すると dev/dotfiles/.config/rstudio/ 内の設定ファイルが更新される。
  • dotfiles は Docker ホスト（コンテナの外）に保存されているので、コンテナを一度停止して再起動しても同じ設定が反映される。
  • 変更した設定を複数のプロジェクト間で共有したい場合は、プロジェクト間で共通の dotfiles を利用する（後述）。

Git の操作

バージョン管理

  • Git でソースコードの変更履歴を管理する。
  • Docker ホストにインストールされた Git や SourceTree などの GUI ツールを使用しても良い。
  • RStudio Server の "Git" タブを使っても、"Terminal" タブからコマンドで操作しても良い。

グローバル設定の管理

  • RStudio Server の "Terminal" タブから git config --global コマンドで設定を変更すると dotfiles の .gitconfig ファイルが書き換えられる。
  • dotfiles は Docker ホスト（コンテナの外）に保存されているので、コンテナを一度停止してから再起動しても同じ設定が反映される。
  • 同じ設定を複数のプロジェクト間で共有したい場合は、プロジェクト間で共通の dotfiles を利用する（後述）。

GitHub との通信

  • コンテナ内から GitHub への push や pull を行いたい場合は、接続用の SSH 秘密鍵を Docker ホストからコンテナへマウントする（後述）。

renv によるパッケージ管理

  • renv によってプロジェクト固有のライブラリ（プライベートライブラリ）が renv/ ディレクトリ内に作成される.
  • 新しいパッケージをライブラリにインストールするときは renv::install() 関数を使用する.
  • ライブラリの状態を記録するには renv::snapshot() 関数を使用する。このとき、ライブラリにインストールされたパッケージとそのバージョン情報が renv.lock ファイルに記録される。この内容を GitHub にプッシュし、チームメンバー間で共有することで同じライブラリの状態が再現される。
  • renv::restore() 関数を使用すると、renv.lock ファイルに記録された情報からライブラリの状態を復元することができる.
  • インストールされたパッケージの実体ファイルは Docker ホスト上（コンテナの外）のパッケージキャッシュに保存される。コンテナを一度停止してｋら再起動したとき、パッケージキャッシュに保存されたファイルが再利用される。

カスタマイズ

.env ファイルによる環境変数の設定

.env.example ファイルをコピーして .env ファイルを作成する。.env ファイル内の環境変数を書き換えることによってコンテナ起動時の設定を制御する。

なおこの環境変数はユーザー rstudio の R セッションに反映されないので注意のこと。 R セッションで使用する環境変数をファイルで管理したい場合は .env ファイルではなく .Renviron ファイルを利用する。

renv パッケージキャッシュのプロジェクト間共有

デフォルトでは renv のパッケージキャッシュ が dev/renv/cache/ に作成される。 しかしこのパッケージキャッシュはプロジェクト固有で使用されるため、保存されたパッケージファイルが別のプロジェクトでは再利用されない。

ダウンロードしたパッケージを他のプロジェクトで再利用するためには、プロジェクト間で共通の renv パッケージキャッシュディレクトリをマシン上に１つ作成する。例えば macOS なら ~/Library/Application Support/renv/cache が標準的なディレクトリパスとなる。

共通パッケージキャッシュを作成したら、.env ファイル内の環境変数 RENV_PATHS_CACHE_HOST でそのパスを指定する。

例：

RENV_PATHS_CACHE_HOST="~/Library/Application Support/renv/cache"

共通 dotfiles によるプロジェクト間での設定共有

デフォルトでは RStudio や Git のグローバル設定が dev/dotfiles/ フォルダ内の .config/rstudio/rstudio-prefs.json や .gitconfig などのファイルに保存される。 しかしこのフォルダはプロジェクト固有で使用されるため、別のプロジェクトには設定内容が反映されない。

設定内容を複数のプロジェクト間で共有したい場合は、プロジェクト固有の dev/dotfiles/ の代わりにプロジェクト間で共通の dotfiles ディレクトリ（例: ~/rproject-dotfiles ）をマシン上に１つ作成する。 共通 dotfiles ディレクトリを作成したら、そのパスを .env ファイル内の環境変数 DOTFILES_ROOT で指定する。

例：

DOTFILES_ROOT=~/rproject-dotfiles

さらに、dotfiles を GitHub リポジトリとして管理することにより複数のマシン間で設定内容を同期することもできる。

Git と GitHub

コンテナ内の Git を使いたい場合は、以下の設定を行う。Docker ホストの Git を使用する場合は設定しなくても良い。

ユーザー名とメールアドレスの設定

RStudio で Terminal ペインを開き、以下のようなコマンドを実行してコンテナ内の Git で使用するユーザー名とメールアドレスを設定する:

git config --global user.name "John Doe"
git config --global user.email johndoe@example.com

この設定内容は dotfiles 内の .gitconfig ファイルに書き込まれる。

SSH 秘密鍵の設定

GitHub に接続するための SSH 秘密鍵を Docker ホストマシン上に保存しておく。秘密鍵のファイルパス（例: ~/.ssh/id_ed25519）を .env の環境変数 GITHUB_SSH_IDENTITY に指定すると、秘密鍵がコンテナにマウントされてコンテナ内部から GitHub に SSH 接続できるようになる。

プロジェクトのマウント先パス

デフォルトではこのプロジェクトフォルダがコンテナ内の /home/rstudio/project にマウントされる。 マウント先のパスは .env の環境変数 PROJECT_PATH_CONTAINER で変更することができる。

例:

PROJECT_PATH_CONTAINER=/home/rstudio/yourproject

参考