本文へスキップ
からだにいいもの

まだ知らない、役に立つ情報を。ゲーム攻略・R・ガジェット

Rで解析:いろいろなモデルから式や変数を同じ書き方で取り出す「insight」パッケージ

「insight」パッケージは、当てはめたモデルから、モデル式、目的変数と説明変数の名前、推定に使ったデータ、係数、モデルの種類といった情報を、同じ書き方で取り出せるパッケージです。渡すのは lm や glm、lme4 の混合モデルなど、さまざまなパッケージで作ったモデルオブジェクトで、モデルの種類ごとに取り出し方を覚え直す必要がありません。取り出した結果は文字ベクトルやリスト、データフレームで返るので、そのまま次の処理に回せます。いくつもの種類のモデルをまとめて扱う解析スクリプトや、モデルの結果を整える自作のコマンドを書くときに役立つのではないかと考えます。

パッケージバージョンは1.7.0。Windows 11 x64 (build 26200)のR version 4.6.1で確認しています。

パッケージのインストール

下記コマンドを実行してください。

# パッケージのインストール
install.packages("insight")

# パッケージの読み込み
library("insight")
Warning message:
package 'insight' was built under R version 4.6.2

# コマンド例実行で必要なパッケージのインストール
install.packages("lme4")

# コマンド例実行で必要なパッケージを読み込み
library("lme4")
Loading required package: Matrix
スポンサーリンク

コマンド例

詳細はコメント、パッケージのヘルプを確認してください。

固定効果はすべての観測に共通する説明変数の効果、ランダム効果は茶園のようなグループごとのばらつきを表す効果です。モデルフレームは、モデルの推定に実際に使われた変数だけを並べたデータです。下記の茶園データと3つのモデルを、以降のコマンド例で使います。

# 乱数のシード値を設定
set.seed(1234)

# 京都府内の茶園データを作成
chaen <- data.frame(
  地区 = factor(rep(c("宇治市", "和束町", "宇治田原", "南丹市"), each = 30)),
  茶園 = factor(rep(paste0("園", 1:24), each = 5)),
  施肥量 = round(runif(120, 20, 60), 1),
  日照時間 = round(rnorm(120, 1800, 150)),
  標高 = round(runif(120, 50, 450))
)

# 一番茶の収量(kg/10a)を作成
chaen$収量 <- round(300 + 3 * chaen$施肥量 + 0.05 * chaen$日照時間 -
  0.1 * chaen$標高 + rep(rnorm(24, 0, 20), each = 5) + rnorm(120, 0, 15))

# 上級品になったかどうか(上級品=1)を作成
chaen$上級 <- rbinom(120, 1, plogis(-4 + 0.08 * chaen$施肥量))

# 収量を説明する線形モデル(変換・交互作用・多項式を含む)
fit_lm <- lm(収量 ~ log(施肥量) + 日照時間 * 地区 + poly(標高, 2), data = chaen)

# 茶園をランダム効果に入れた混合モデル
fit_mix <- lmer(収量 ~ 施肥量 + 日照時間 + (1 | 茶園), data = chaen)

# 上級品になるかどうかのロジスティック回帰
fit_glm <- glm(上級 ~ 施肥量 + 地区, family = binomial, data = chaen)

モデル式の取り出し:find_formulaコマンド

オプション意味初期値
x当てはめたモデルを指定なし
dichotomies論理値。nestedLogitのモデルのとき、二分割ごとのモデル式を返すかを指定FALSE
verbose警告を表示するかを指定TRUE
…現在は使われていないなし
# 線形モデルのモデル式を取り出す
find_formula(fit_lm)
$conditional
収量 ~ log(施肥量) + 日照時間 * 地区 + poly(標高,
    2)

attr(,"class")
[1] "insight_formula" "list"

# 混合モデルは固定効果とランダム効果の式に分けて返る
find_formula(fit_mix)
$conditional
収量 ~ 施肥量 + 日照時間

$random
~1 | 茶園
<environment: 0x000001da0de78ea8>

attr(,"class")
[1] "insight_formula" "list"

モデルに使われた変数名の一覧:find_variablesコマンド

オプション意味初期値
x当てはめたモデルを指定なし
effects固定効果(”fixed”)、ランダム効果(”random”)、両方(”all”)のどれの変数を返すかを指定。混合モデルのみに効く。省略形も可“all”
component条件付きモデル、ゼロ過剰部分、分散の項、操作変数などのどの部分を返すかを指定。”all”で全部、”location”で位置パラメータ、”distributional”(”auxiliary”)でsigmaや分散などの補助パラメータを返す。省略形も可“all”
flatten論理値。TRUEでリストではなく重複を除いた文字ベクトルで返すFALSE
verbose警告を表示するかを指定TRUE
# 混合モデルの変数を目的変数・固定効果・ランダム効果に分けて取り出す
find_variables(fit_mix)
$response
[1] "収量"

$conditional
[1] "施肥量"   "日照時間"

$random
[1] "茶園"

# 固定効果の変数だけを文字ベクトルで取り出す
find_variables(fit_mix, effects = "fixed", flatten = TRUE)
[1] "収量"     "施肥量"   "日照時間"

説明変数名の取り出し:find_predictorsコマンド

オプション意味初期値
x当てはめたモデルを指定なし
effects固定効果(”fixed”)、ランダム効果(”random”)、両方(”all”)のどれの変数を返すかを指定。混合モデルのみに効く。省略形も可“fixed”
component条件付きモデル、ゼロ過剰部分、分散の項、操作変数などのどの部分を返すかを指定。”all”で全部、”location”で位置パラメータ、”distributional”(”auxiliary”)でsigmaや分散などの補助パラメータを返す。省略形も可“all”
flatten論理値。TRUEでリストではなく重複を除いた文字ベクトルで返すFALSE
verbose警告を表示するかを指定TRUE
…現在は使われていないなし
# 線形モデルの説明変数名を取り出す(log()やpoly()を外した元の変数名)
find_predictors(fit_lm)
$conditional
[1] "施肥量"   "日照時間" "地区"     "標高"

# 混合モデルのランダム効果のグループ変数も含めて取り出す
find_predictors(fit_mix, effects = "all", flatten = TRUE)
[1] "施肥量"   "日照時間" "茶園"

目的変数名の取り出し:find_responseコマンド

オプション意味初期値
x当てはめたモデルを指定なし
combine論理値。目的変数が行列の列のとき、TRUEでモデル式の書き方どおり(cbind(…)を含む)の名前を返し、FALSEで行列の列の元の変数名を返すTRUE
component結合モデルのとき、どの部分を返すかを指定。”conditional”、”survival”、”all”から選ぶ“conditional”
…現在は使われていないなし
# ロジスティック回帰の目的変数名を取り出す
find_response(fit_glm)
[1] "上級"

# 混合モデルでも同じ書き方で取り出せる
find_response(fit_mix)
[1] "収量"

モデル式の項の取り出し:find_termsコマンド

オプション意味初期値
x当てはめたモデルを指定なし
flatten論理値。TRUEでリストではなく重複を除いた文字ベクトルで返すFALSE
as_term_labels論理値。TRUEでモデル式の”term.labels”属性を使い、terms()に近い結果を返す。混合モデルなどでは足りないことがあるFALSE
verbose警告を表示するかを指定TRUE
…現在は使われていないなし
# 変換や多項式を含んだままの項を取り出す
find_terms(fit_lm)
$response
[1] "収量"

$conditional
[1] "log(施肥量)"   "日照時間"      "地区"          "poly(標高, 2)"

# 交互作用の項も含めて取り出す
find_terms(fit_lm, as_term_labels = TRUE)
$conditional
[1] "log(施肥量)"   "日照時間"      "地区"          "poly(標高, 2)"
[5] "日照時間:地区"

推定に使ったデータの取り出し:get_dataコマンド

オプション意味初期値
x当てはめたモデルを指定なし
sourceデータをどこから取り出すかを指定。”environment”は作業環境にある元のデータから取り出し、”frame”(”mf”)はモデルフレームから取り出して変換した変数を可能なら元に戻す。どちらも欠測のない観測だけを返す“environment”
verboseメッセージと警告を表示するかを指定TRUE
include_intervalメタアナリシスのモデルのとき、効果量ごとの正規近似の信頼区間を加えるかを指定FALSE
transfメタアナリシスのモデルで信頼区間を加えるとき、効果量と信頼区間に当てるコマンドを指定NULL
transf_argsメタアナリシスのモデルのとき、transfに渡すオプションをリストで指定NULL
ciメタアナリシスのモデルでinclude_interval = TRUEのときの信頼区間の水準を指定0.95
…現在は使われていないなし
# 線形モデルの推定に使った変数だけを取り出す
head(get_data(fit_lm), 3)
  収量 施肥量 日照時間   地区 標高
1  470   24.5     1898 宇治市   51
2  508   44.9     2182 宇治市  273
3  497   44.4     1795 宇治市  234

# モデルフレームから取り出す
head(get_data(fit_glm, source = "frame"), 3)
  上級 施肥量   地区
1    0   24.5 宇治市
2    0   44.9 宇治市
3    1   44.4 宇治市

モデルの種類の確認:model_infoコマンド

オプション意味初期値
x当てはめたモデルを指定なし
response多変量の目的変数を持つモデルのとき、情報を返す目的変数を番号か名前で指定NULL
…現在は使われていないなし
# ロジスティック回帰のモデル情報を取り出す
mi <- model_info(fit_glm)

# ロジットリンクかどうか
mi$is_logit
[1] TRUE

# 二項分布かどうか
mi$is_binomial
[1] TRUE

# 分布族の名前
mi$family
[1] "binomial"

# 混合モデルかどうかを確認する
model_info(fit_mix)$is_mixed
[1] TRUE

推定値の取り出し:get_parametersコマンド

オプション意味初期値
x当てはめたモデルを指定なし
verboseメッセージと警告を表示するかを指定TRUE
…現在は使われていないなし
# ロジスティック回帰の推定値をデータフレームで取り出す
get_parameters(fit_glm)
     Parameter    Estimate
1  (Intercept) -3.69118886
2       施肥量  0.07988838
3 地区宇治田原 -0.05148245
4   地区南丹市 -0.04597085
5   地区和束町 -0.39418304

# 混合モデルでは固定効果の推定値が返る
get_parameters(fit_mix)
    Parameter     Estimate
1 (Intercept) 245.77279075
2      施肥量   3.18288313
3    日照時間   0.06376786


この記事が誰かの役に立ちますように。

スポンサーリンク
価格および配送状況は変更される場合があります。購入時は商品ページをご確認ください。
当サイトに表示されている商品情報はAmazonから提供されたものであり、更新または削除される場合があります。
karada-goodはAmazonアソシエイトとして、適格販売により収入を得ています。