Tools for Easy Use of 'e-Stat' API.

japanstat

README is currently only available in Japanese.

japanstatは日本政府統計のポータルサイトであるe-StatのAPIを利用するためのツールを提供します． クエリの自動生成，データの収集，フォーマットなどの機能を備えています．

e-Stat APIの利用にはアカウント登録 (appIdと呼ばれるAPIキーの発行) が必要です (詳しくはホームページを参照してください)． また，データ利用に際しては利用規約に従う必要があります．

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

インストール方法

install.packages("japanstat")

japanstatの開発版は，GitHubから以下の方法でインストールできます．

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

使用方法

library(japanstat)
library(magrittr)

データ取得・整形の概要

データ取得・整形の一連の流れは以下のようになります．詳細な使用方法は次の項目で説明します．

# APIキーの設定
estat_set_apikey("Your e-Stat appId")

# メタ情報の取得
census_2015 <- estat("https://www.e-stat.go.jp/dbview?sid=0003411172")

# 列名・アイテム数・属性変更
census_2015 <- census_2015 %>%
  
  estat_activate("表章項目") %>% 
  filter(name == "人口") %>% 
  select() %>% 
  
  estat_activate("全国", "region") %>% 
  select(code, name) %>% 
  
  estat_activate("時間軸", "year") %>% 
  filter(name %in% c("2000年", "2005年", "2010年", "2015年")) %>% 
  select(name)

# データのダウンロード
census_2015 <- estat_download(census_2015, "pop")
#> The total number of data is 12.

knitr::kable(census_2015)

データ取得・整形の流れ

japanstatでは，e-Stat APIのメタ情報取得 (getMetaInfo) と統計データ取得 (getStatsData) を用いて，統計表をダウンロードが可能です． 以下のように，APIキー (appId) をあらかじめ設定してください．

estat_set_apikey("Your e-Stat appId")

e-Statでは，統計表ごとに統計表ID (statsDataId) が付与されています．統計表IDは， データセット情報ページ (例1) や 統計表・グラフ表示ページ (例2) のURLからも取得することが可能です．

ここでは，例2に挙げた2015年国勢調査データを対象とします． まず，データセット情報ページなどのURLまたは統計表ID (statsDataId) を，estat()関数に入力してメタ情報 (統計データの属性情報) を取得します．

# 2015年国勢調査 データセット情報ページ URL
census_2015 <- estat("https://www.e-stat.go.jp/dbview?sid=0003411172")
census_2015
#> # Keys
#> # [ ] tab  : 表章項目                     > tab   [2]  (code, name, level, unit)
#> # [ ] cat01: 全国，市部，郡部2015         > cat01 [3]  (code, name, level, parentCode)
#> # [ ] time : 時間軸（調査年組替表記有り） > time  [26] (code, name, level, parentCode)
#> #
#> # No active key

estat_table_info()関数で統計表情報を表示します．

knitr::kable(estat_table_info(census_2015))

当該データには，tab，cat01，timeの3種類の列 (以下，キーと呼びます) が存在します． それぞれのキーの (>の) 右側には以下の情報が記載されています．

1. デフォルトでの列名 (tabなど)
2. アイテム数 ([2]など)
3. コード・名称などの属性 ((code, name, level, unit)など)

ここからは，それぞれのキーごとに列名・アイテム数・属性を変更する方法を説明します． それぞれのキーの情報を変更するためには，estat_activate()関数を用いてキーを選択します． estat_activate()では，正規表現パターンでキーを選択します (複数マッチする場合にはエラー)． また，estat_activate_tab()関数などidでのキー選択も可能です．

例えば，以下のようにtabキーをアクティブにします．

census_2015
#> # Keys
#> # [ ] tab  : 表章項目                     > tab   [2]  (code, name, level, unit)
#> # [ ] cat01: 全国，市部，郡部2015         > cat01 [3]  (code, name, level, parentCode)
#> # [ ] time : 時間軸（調査年組替表記有り） > time  [26] (code, name, level, parentCode)
#> #
#> # No active key

census_2015 %>% 
  # estat_activate_tab()
  estat_activate("表章項目")
#> # Keys
#> # [x] tab  : 表章項目                     > tab   [2]  (code, name, level, unit)
#> # [ ] cat01: 全国，市部，郡部2015         > cat01 [3]  (code, name, level, parentCode)
#> # [ ] time : 時間軸（調査年組替表記有り） > time  [26] (code, name, level, parentCode)
#> #
#> # A tibble: 2 x 4
#>   code  name             level unit 
#>   <chr> <chr>            <chr> <chr>
#> 1 020   人口             ""    人   
#> 2 1420  市部，郡部別割合 ""    ％

キーをアクティブにすると当該キーのアイテム情報が表示されます． さらに，filter()関数やselect()関数を用いてアイテム情報の絞り込みなどが可能です． ここでは，「人口」のみを選択します．

census_2015 <- census_2015 %>% 
  estat_activate("表章項目") %>% 
  filter(name == "人口") %>% 
  # アイテム数が1つのみであるため列を全て削除
  select()

次に，cat01の「全国，市部，郡部2015」を選択します．cat01では，属性が分かりづらいため，estat_activate()関数 (ここでは，"region") で名称の変更を行います． また，上と同様に属性の絞り込みを行います． ここでは，codeとname列を選択します．この場合，ダウンロードデータの列名は，それぞれ，region_code，region_nameになります．

census_2015 <- census_2015 %>% 
  # estat_activate_cat(1, "region") %>% 
  estat_activate("全国", "region") %>% 
  select(code, name)

上と同様に，timeの「時間軸（調査年組替表記有り）」の名称変更・属性絞り込みを行います． ここでは，2000～2015年データを選択します．

census_2015 <- census_2015 %>% 
  estat_activate("時間軸", "year") %>% 
  filter(name %in% c("2000年", "2005年", "2010年", "2015年")) %>% 
  select(name)

以上の操作により，以下のように列名・アイテム数・属性が変更できました．

census_2015
#> # Keys
#> # [ ] tab  : 表章項目                     > tab    [1] ()
#> # [ ] cat01: 全国，市部，郡部2015         > region [3] (code, name)
#> # [x] time : 時間軸（調査年組替表記有り） > year   [4] (name)
#> #
#> # A tibble: 4 x 1
#>   name  
#>   <chr> 
#> 1 2000年
#> 2 2005年
#> 3 2010年
#> 4 2015年

最後に，estat_download()関数を用いてデータをダウンロードします．

census_2015 <- census_2015 %>%
  # 値の名称を"pop"とする
  estat_download("pop")
#> The total number of data is 12.
knitr::kable(census_2015)