knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
library(stringr)

estatr

e-Stat APIのクエリの作成(データ絞り込み)・データのダウンロードを行うためのRパッケージです. コードの対応関係の確認等に時間を割かずに,単純なデータフレーム操作でダウンロードデータの絞り込み・整形が可能です.

このサービスは、政府統計総合窓口(e-Stat)のAPI機能を使用していますが、サービスの内容は国によって保証されたものではありません。

インストール

CRAN上には公開されていないため,GitHubからインストールしてください.

# install.packages("devtools")
devtools::install_github("UchidaMizuki/estatr")

データ取得の流れ

estatオブジェクトの作成

library(estatr)
library(magrittr)
library(dplyr)
appId <- "Your own e-Stat appId"
appId <- keyring::key_get("e-Stat-appId")
# estatオブジェクト作成例
my_estat <- estat$new(statsDataId = "0003413193", 
                      appId = appId)

データ概要の確認

必要に応じてinfoでデータの概要を確認できます.

my_estat$info

属性情報の確認

keyvalueで属性情報を確認できます. 表章項目が存在する場合に限り,valueに表章項目が格納されます.

names(my_estat$key)
my_estat$value

keyvalueには各属性情報がデータフレームで格納されます. 例としてkeyの「移動後の住所地(現住地)2019~」の属性情報を示します.

my_estat$key$"移動後の住所地(現住地)2019~"

属性情報の絞り込み

keyvalueのデータフレームを上書きすることにより自動的に(cdCat01などの)クエリが作成できます. データの上書きにmagrittrパッケージの%<>%を使用することで,プログラムをシンプルにしています.

# データ絞り込み例
my_estat$key$"移動後の住所地(現住地)2019~" %<>%
  filter(name == "北海道")
my_estat$key$"国籍" %<>%
  filter(name == "移動者")
my_estat$key$"移動前の住所地(前住地)2019~" %<>%
  filter(level == "2")

# `key`の絞り込みをやり直したい場合には,`restore_key()`メソッドを実行(全てのkeyが初期化される).
# my_estat$restore_key()

# 同様に,`restore_value()`で`value`の絞り込みが初期化されます.

データ取得

get_data()メソッドを実行するとデータが取得され,dataにデータが格納されます. dataのkeyは,codenamelevel等のそれぞれのラベルに対して設定されます. dataのvalueは,表章項目が存在する場合には,項目_単位という形式で出力されます. ただし,単位が存在しない場合には単位が記載されず,表章項目が存在しない場合には単にvalueと名付けられます.

my_estat$get_data()

my_estat$data %>% 
  colnames()

my_estat$data %>% 
  select("name_移動後の住所地(現住地)2019~", "name_移動前の住所地(前住地)2019~", "他市区町村からの転入者数_人")


UchidaMizuki/estatr documentation built on Nov. 4, 2021, 8:21 p.m.