Top 5 This Week

関連記事

パッケージの入れ方と読み込み

- 本サイト運営者のサービスの紹介 -
Dr.データサイエンス|医療統計解析の代行・相談

教科書に載っているRのコードを写して実行した時、生存時間解析のsurvivalパッケージは読み込めるのに、別のパッケージを読み込む行でエラーが出て止まることがあります。survivalは推奨パッケージとしてR本体と一緒に配布されている一方、それ以外の多くのパッケージは配布元から自分のパソコンへ入れて初めて使えるようになるため、この扱いの差がそのまま実行結果の差になって現れます。

さらに、同じスクリプトを半年後や別のパソコンで実行すると、パッケージの更新によって関数の既定値や計算の細部が変わり、以前と同じ数値が得られない場合もあります。パッケージを入れる操作、読み込む操作、使った版を残す操作は役割が異なるため、これらを混同したままではエラーの原因も数値が変わった原因も特定しにくくなります。

インストールは1回、読み込みはセッションごと

Rが起動できる状態(R本体とRStudioの準備はRとRStudioの導入:最初に設定することで扱っています)からパッケージを使えるようになるまでには、配布元から自分のパソコンのライブラリ(インストール先のフォルダ)へファイルを複製する段階と、そのライブラリから現在のRセッションへ関数を呼び出せる状態にする段階があります。R Core Teamによる公式マニュアル『R Installation and Administration』は、前者をパッケージのインストール、ライブラリをインストール済みパッケージを収めるディレクトリとして説明しており、一度入れたパッケージはRを終了してもライブラリに残ります。

これに対して、RStudioを再起動したり新しいRセッションを開いたりすると、読み込んだパッケージは外れた状態に戻り、読み込みの効果はそのRセッションの中だけで続きます。そのため、解析スクリプトでは冒頭で毎回読み込む形になります。

この性質の違いを考えると、インストールの命令をスクリプトに書いて毎回実行させる形は、実行のたびにネットワーク接続を要求し、しかも実行した日によって入る版が変わり得るため、結果の再現を妨げる書き方として不適切です。そこで以下のコードでは、インストールの命令を行頭に#を付けたコメントとして示し、初回に1回だけ手で実行する前提にしています。

R本体、CRAN、ライブラリ、セッションの関係

図1は、この二つの段階を、R本体、CRAN(Comprehensive R Archive Network)、ライブラリ、セッションの四つの箱で描いた模式図です。CRANからライブラリへの矢印がインストール、ライブラリからセッションへの矢印が読み込みに当たり、前者は1回、後者はセッションを開くたびに通る経路です。

plot(NA, xlim = c(0, 10), ylim = c(0, 6), axes = FALSE, xlab = "", ylab = "")
rect(c(0.2, 3.7, 7.2), 3.2, c(2.8, 6.3, 9.8), 5.2, col = "grey92")
rect(3.7, 0.3, 6.3, 2.3, col = "grey92")
text(c(1.5, 5, 8.5, 5), c(4.2, 4.2, 4.2, 1.3),
     labels = c("CRAN\n(repository)", "Library\n(installed packages)",
                "R session\n(attached packages)", "R itself\n(base + recommended)"))
arrows(2.8, 4.2, 3.7, 4.2, length = 0.1)
arrows(6.3, 4.2, 7.2, 4.2, length = 0.1)
arrows(5, 2.3, 5, 3.2, length = 0.1)
text(c(3.25, 6.75), 5.7, labels = c("install once", "load every session"), cex = 0.8)
text(5.6, 2.75, labels = "bundled", cex = 0.8)
CRAN、ライブラリ、Rセッションを左から右へ矢印でつなぎ、R本体からライブラリへ下から矢印が入る模式図です。CRANからライブラリへの矢印にinstall once、ライブラリからセッションへの矢印にload every sessionと書かれています。
図1 パッケージがセッションで使えるようになるまでの経路です。CRANからのインストールは1回で済みますが、ライブラリからの読み込みはセッションごとに必要で、推奨パッケージはR本体と一緒にライブラリへ入ります。

図の下側にあるR本体からの矢印は、survivalのような推奨パッケージの経路です。『R Installation and Administration』によれば、推奨パッケージは通常のRのインストールに含まれて導入されるため、CRANから取得する段階を経ずにライブラリに入っており、読み込みの段階だけで使えます。

一方、同梱されるのは推奨パッケージの一群に限られ、それ以外のパッケージは図の上側の経路、つまりCRANからのインストールを1回経てからでないと読み込めません。手元のパソコンでsurvivalが動いたことは共同研究者のパソコンで別のパッケージが動くことを保証しないため、スクリプトを共有する時は使うパッケージの名前を冒頭にまとめておくと、受け取った側が足りないものを最初の数行で判別できます。

エラーで止めるか、有無を確かめるか

パッケージがライブラリに見つからない時、Rの二つの関数は異なる振る舞いをします。library()は見つからなければエラーを出してスクリプトをそこで止め、requireNamespace()は読み込みを試みた結果をTRUEかFALSEの値として返すだけで処理を続けるため、前者は必須のパッケージに、後者は有無によって処理を分けたい場面に向いています。

# install.packages("survival")  # 初回に1回だけ実行(ネットワークが必要)
has_survival <- requireNamespace("survival", quietly = TRUE)
has_survival
if (has_survival) library(survival)
packageVersion("survival")
print(requireNamespace("noSuchPkgXYZ", quietly = TRUE))
#> [1] TRUE
#> [1] ‘3.8.3’
#> [1] FALSE

出力の1行目のTRUEはsurvivalがこのパソコンのライブラリにあったことを表し、続く3.8.3が読み込んだsurvivalの版番号です。存在しない名前noSuchPkgXYZを渡した最後の行はFALSEを返して処理が続き、同じ名前をlibrary()で読み込もうとした場合はエラーで停止することを、解析スクリプトの検算で確かめています。

この振る舞いの差を置き場所に当てはめると、主解析に欠かせないパッケージは、足りなければ先へ進んでも意味がないので冒頭でlibrary()により読み込み、止まった位置から原因を特定できるようにします。また、追加の図を描くためだけの補助的なパッケージのように、なくても主解析が成り立つものは、有無を確かめてから処理を分ける書き方の方が、途中でスクリプト全体が止まる事態を避けられます。

ただし、requireNamespace()は名前空間を読み込むだけで検索経路には加えないため、TRUEが返った時点でも関数名をそのまま書いて呼べる状態にはなっていません。上のコードでTRUEの後にlibrary()を続けているのはこのためで、読み込まずに使う場合はパッケージ名::関数名の形で呼びます。

同じ名前の関数とパッケージ名::関数名

複数のパッケージに同じ名前の関数がある時は、後から読み込んだパッケージの関数が先に見つかり、それまで使えていた関数が名前だけでは呼ばれなくなります。この状態はマスクと呼ばれ、よく知られた例がfilterで、R本体のstatsパッケージにある時系列に移動平均などをかける関数と、データ整形のdplyrパッケージにある条件で行を選ぶ関数が同じ名前を持っています。

この探し方を式で書くと、名前だけで関数$f$を呼んだ時に使われるのは、検索経路の$k$番目の環境を$E_k$として、$f$を含む環境のうち最も前にあるものです。

$$k^{*} = \min\{\, k : f \in E_k \,\} \tag{1}$$

この式(1)の検索経路は、作業中の環境、後から読み込んだパッケージ、R本体のパッケージの順に並ぶので、後から読み込んだパッケージほど$k$が小さくなり、同じ名前の関数を先に見つけられます。名前空間を指定したstats::filterの形は、この探し方を通らずに、指定したパッケージの関数を直接呼ぶ書き方です。

そこで、dplyrがない環境でも確かめられる範囲で、filterという名前の関数が今どこにあるかを調べ、名前空間を指定した呼び出しの結果と並べました。

find("filter")
find("Filter")
values <- 1:5
as.numeric(stats::filter(values, rep(1 / 3, 3), sides = 2))
Filter(function(v) v %% 2 == 0, values)
#> [1] "package:stats"
#> [1] "package:base"
#> [1] NA  2  3  4 NA
#> [1] 2 4

出力の1行目から、このセッションでfilterはstatsパッケージにだけあり、大文字で始まるFilterはbaseパッケージにある別の関数だと読み取れます。stats::filterの形で名前空間を指定して1から5の値に3点移動平均をかけると、両端がNAで中央が2、3、4になり、条件に合う偶数を残すFilterの結果2と4とは、目的も出力の長さも異なります。

同名の関数を持つパッケージを読み込んだ後に同じ確認を行うと、複数のパッケージ名が並び、名前だけで呼んだ時には先頭に表示されたパッケージの関数が使われます。そのため、同名の関数があると分かっている場面で名前空間を指定せずに使う書き方は、読み込みの順序を入れ替えただけで別の関数が呼ばれ、エラーが出ないまま異なる計算が進む危険があり、不適切です。

もっとも、全ての関数呼び出しにパッケージ名を付けるとコードが長くなり、読む側の負担が増えます。名前空間の指定を、同名の関数が存在すると分かっているものと、スクリプトの中で一度しか使わないパッケージの関数に絞ると、読みやすさと取り違えの防止を両立できます。

Rとパッケージの版を記録する

同じコードと同じデータでも、パッケージの版が変わると既定の引数や数値計算の細部が更新され、出力の桁や警告が変わることがあります。Sandveら(2013)は再現可能な計算研究のための10の規則の一つに、使った外部プログラムの正確な版を保存しておくことを挙げており、後から同じ結果を得るには解析環境の情報が欠かせないと論じています。

この記録に必要な情報は、Rの版と、読み込んだパッケージの版の二つです。Rの版を表す文字列と、セッション情報から取り出したsurvivalの版を表示しました。

R.version.string
session <- sessionInfo()
session$otherPkgs$survival$Version
#> [1] "R version 4.4.2 (2024-10-31)"
#> [1] "3.8-3"

1行目はRの版と公開日を表し、ここでは2024年10月31日公開のR 4.4.2でした。セッション情報は全体を表示するとOSや言語設定まで並びますが、記録の目的で読む場所は、先頭にあるRの版と、other attached packagesの欄に並ぶ読み込んだパッケージとその版番号で、今回の環境ではsurvivalの3.8.3が載っており、2行目の値と一致しています。

なお、版番号は実行したパソコンとRの更新状況によって異なるため、同じコードを別の環境で実行すると、ここに載せたものとは別の番号が出ることがあります。その番号こそ記録しておく情報で、論文の解析方法の欄にRと主要パッケージの版を書く時も、この出力から転記します。

さらに、プロジェクトごとにパッケージの版を固定したい場合には、renvのようなプロジェクト単位で版を管理するパッケージがあります。renvはプロジェクトで使ったパッケージとその版をロックファイルに書き出し、別のパソコンでも同じ版を復元できるようにするため、共同研究者とスクリプトを共有する研究や、査読後に再解析が必要になる論文で役立ちます。

論文や報告書ではどう扱われているか

Peng(2011)は計算を用いる研究の再現可能性について、データとコードを公開し他者が同じ計算を実行できる状態を、独立した追試が難しい場合に求める最低限の水準として位置づけています。コードが公開されていても、そのコードが前提とするパッケージの版が分からなければ受け取った側は同じ計算を再実行できないため、パッケージの名前と版はこの水準を満たすための情報の一部になります。

この考え方に沿うと、論文の統計解析の節には「統計解析にはR 4.4.2とsurvivalパッケージ3.8.3を用いた」のように、Rと解析の中心となったパッケージの版を書く形になります。一方、補助的に使ったパッケージまで全て本文に並べると読みにくくなるので、セッション情報の出力全体は補足資料やコードの公開先に置き、本文には結果に直接関わるパッケージを挙げると、読みやすさと再現性を両立できます。

報告書でも事情は同じで、集計や図の作成にRを使った場合、版の記載がなければ数値の再確認を求められた時に当時の環境を復元する手がかりがありません。Sandveら(2013)が版の保存を規則として挙げたのも、解析の後になって環境を思い出すことが難しいという理由によるもので、記録は解析を終えた時点ではなく結果を出したその時に残しておく必要があります。

解析スクリプトの冒頭に置くもの

解析スクリプトの冒頭は、そのスクリプトが何を必要とするかを読む人に伝える場所でもあります。読み込みの命令を冒頭にまとめておけば、足りないパッケージがある時は最初の数行でエラーが出て止まり、解析の途中まで進んでから止まって中間結果が半端に残る事態を避けられます。

この冒頭の部分に、インストールの命令は実行する形では置きません。初回の環境構築用に別のファイルへ分けるか、上のコードのように行頭に#を付けたコメントとして残しておくと、新しいパソコンで解析を始める人はコメントを見て必要なパッケージを1回だけ入れ、以後は読み込みだけでスクリプトを実行できます。

また、読み込みの順序も冒頭で決まります。同名の関数を持つパッケージを複数読み込む時は後に読み込んだ方が優先されるので、データファイルを読むパッケージを冒頭に並べる場合の選び方はデータの読み込み:CSVとExcelファイルと合わせて確認し、名前の重なる関数にはパッケージ名を付けておくと取り違えを防げます。

加えて、スクリプトの末尾でセッション情報をテキストファイルに保存しておくと、結果を出した時点の環境がそのまま残ります。後で数値が変わった時に、データの変更とパッケージの更新のどちらが原因かを切り分ける手がかりとなり、論文の解析方法欄に書く版番号もこの記録から転記できます。

参考文献

  1. Sandve GK, Nekrutenko A, Taylor J, Hovig E. Ten simple rules for reproducible computational research. PLoS Comput Biol. 2013;9(10):e1003285.
  2. Peng RD. Reproducible research in computational science. Science. 2011;334(6060):1226-1227.
  3. R Core Team. R Installation and Administration. R Foundation for Statistical Computing.

Popular Articles