Rで解析:動作環境を自動チェックできる「checker」パッケージの紹介
Rを用いた講義やワークショップでは、受講者ごとにRやRStudio、必要なパッケージのバージョンが異なり、環境の差異がスムーズな進行の妨げになる場面があります。しかし、受講者一人ひとりの環境を個別に確認するには手間がかかります。「checker」パッケージは、必要なプログラムやパッケージ、推奨するRStudioの設定がインストール・適用されているかを自動でチェックする機能を提供します。確認したい条件をYAMLファイルにまとめておき、そのファイルをもとに受講者の環境と照合することが可能です。また、条件を満たしていない項目については、その旨のメッセージを表示することも可能です。本パッケージの利用で、環境確認にかかる手間を軽減できるのではないかと考えます。
パッケージバージョンは0.1.5。Windows 11 x64 (build 26200)のR version 4.6.1で確認しています。
<おすすめのRに関する書籍です>
遺伝統計学の基礎 Rによる遺伝因子解析・遺伝子機能解析
遺伝因子解析・遺伝子機能解析をRで行うための教科書。ゲノム解析に特有の統計的な考え方を学べる。
パッケージのインストール
下記コマンドを実行してください。
# パッケージのインストール
install.packages("checker")
# パッケージの読み込み
library("checker")
スポンサーリンク
コマンド例
詳細はコメント、パッケージのヘルプを確認してください。
必須パッケージを含む設定ファイルの作成:chk_makeコマンド
受講者に必要なプログラムやパッケージ、推奨するRStudioの設定をまとめたYAMLファイルを作成するために使用します。作成したファイルは、chk_requirementsコマンドでの確認に使います。
| オプション | 意味 | 初期値 |
|---|---|---|
| path | ファイル名とパス(未指定時は画面に表示) | なし |
| programs | 必要なプログラムを記述したデータフレーム | なし |
| packages | 必要なパッケージを記述したデータフレーム | なし |
| options | 推奨するRStudioの設定を記述したデータフレーム | なし |
# 京都市内で開催するR入門講座に必要なパッケージ情報を読み込む
pak <- read.csv(
text = "package, recommended, minimum, message
dplyr, 1.1.4, 1.0.0, NA
stringr, 1.5.1, NA, NA",
strip.white = TRUE
)
# 受講者に必要なプログラム情報を読み込む
prog <- read.csv(text = 'program, recommended, minimum, message
rstudio, 2024.04.2, NA, NA
R, "4.4.1", "4.2.0", NA
git, NA, NA, "共同作業のため必須です"',
strip.white = TRUE)
# 推奨するRStudioのオプション情報を読み込む
opt <- read.csv(text = 'option, value, message
"save_workspace", "never", NA
"load_workspace", "FALSE", "毎回まっさらな状態から作業を始めるための設定です"',
strip.white = TRUE)
# 一時ファイルのパスを生成する
f <- tempfile(fileext = ".yaml")
# 設定ファイルを生成する
(chk_make(path = f, programs = prog, packages = pak, options = opt))
[1] "rstudio:\n recommended: 2024.04.2\n options:\n save_workspace:\n value: never\n load_workspace:\n value: 'FALSE'\n message: 毎回まっさらな状態から作業を始めるための設定です\nR:\n recommended: 4.4.1\n minimum: 4.2.0\ngit:\n message: 共同作業のため必須です\npackages:\n dplyr:\n recommended: 1.1.4\n minimum: 1.0.0\n stringr:\n recommended: 1.5.1\n"
# 一時ファイルを削除する
unlink(f)学習前の環境設定確認:chk_requirementsコマンド
chk_makeコマンドで作成したYAMLファイル(省略した場合はパッケージに同梱の既定ファイル)をもとに、Rのバージョンや必要なパッケージ、プログラムなどの条件を実行環境が満たしているかを確認します。
| オプション | 意味 | 初期値 |
|---|---|---|
| path | YAMLファイルへのパス(省略時はパッケージに同梱の既定ファイルを使用) | system.file(“default.yaml”, package = “checker”) |
# 受講者の環境を確認する
chk_requirements()
→ Date = 2026-09-04 05:31:28.507262
→ os = Windows 11 x64 (build 26200)
✖ Are you using RStudio?
✔ R version 4.6.1 is installed
✖ Please install quarto R package
✔ git version 2.55.0..3 is installed
→ Checking R packages
✔ tidyverse version 2.0.0 is installed
✔ here version 1.0.2 is installed
✖ You have some issues that need addressing
この記事が誰かの役に立ちますように。
スポンサーリンク