README.Rmd

---
output: github_document
editor_options: 
  markdown: 
    wrap: 72
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

# jpstat <a href="https://uchidamizuki.github.io/jpstat/"><img src="man/figures/logo.png" align="right" height="139"/></a>

<!-- badges: start -->

[![CRAN
status](https://www.r-pkg.org/badges/version/jpstat)](https://CRAN.R-project.org/package=jpstat)

<!-- badges: end -->

**README is currently only available in Japanese.**

jpstatは日本政府統計のポータルサイトであるe-Statや RESAS
(地域経済分析システム) などのAPIを利用するためのツールを提供します．

現在，以下のAPIに対応しています．

-   e-Stat API: <https://www.e-stat.go.jp/api/>
-   RESAS API: <https://opendata.resas-portal.go.jp>
-   不動産取引価格情報取得API:
    <https://www.land.mlit.go.jp/webland/api.html>

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

## インストール方法

``` r
install.packages("jpstat")
```

jpstatの開発版は，[GitHub](https://github.com/)から以下の方法でインストールできます．

``` r
# install.packages("devtools")
devtools::install_github("UchidaMizuki/jpstat")
```

```{r, message=FALSE, warning=FALSE}
library(jpstat)
library(dplyr)
```

## e-Stat API

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

データ取得・整形の一連の流れは以下のようになります．
ここでは，[国勢調査データ](https://www.e-stat.go.jp/dbview?sid=0003413949)を対象として，
2010・2015年の東京都・大阪府における男女別人口を取得します．
詳細な使用方法は[こちら](https://github.com/uchidamizuki/jpstat/blob/main/README-estat.md)を参照してください．

```         
# APIキーの設定
Sys.setenv(ESTAT_API_KEY = "Your appId")

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

```{r,echo=FALSE}
census <- estat(statsDataId = "https://www.e-stat.go.jp/dbview?sid=0003410379")
census
```

```{r}
# 2010・2015年の東京都・大阪府における男女別人口を取得
census <- census |> 
  
  activate(tab) |> 
  filter(name == "人口") |> 
  select() |> 
  
  activate(cat01) |> 
  rekey("sex") |> 
  filter(name %in% c("男", "女")) |> 
  select(name) |> 
  
  activate(area) |> 
  rekey("pref") |> 
  filter(name %in% c("東京都", "大阪府")) |> 
  select(code, name) |> 
  
  activate(time) |> 
  rekey("year") |> 
  filter(name %in% c("2010年", "2015年")) |> 
  select(name) |> 
  
  collect(n = "pop")

knitr::kable(census)
```

## RESAS API

[![Lifecycle:
experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)

RESAS APIの利用にはアカウント登録 (X-API-KEYと呼ばれるAPIキーの発行)
が必要です
(詳しくは[ホームページ](https://opendata.resas-portal.go.jp)を参照してください)．
RESAS
APIの利用にあたっては，[利用規約](https://opendata.resas-portal.go.jp/terms.html)を確認してください
([API詳細仕様](https://opendata.resas-portal.go.jp/docs/api/v1/detail/index.html))．

```         
Sys.setenv(RESAS_API_KEY = "Your X-API-KEY")

power_for_industry <- resas(path = "https://opendata.resas-portal.go.jp/docs/api/v1/industry/power/forIndustry.html")
power_for_industry
```

```{r, echo=FALSE}
power_for_industry <- resas(path = "https://opendata.resas-portal.go.jp/docs/api/v1/industry/power/forIndustry.html")
power_for_industry
```

```{r}
power_for_industry <- power_for_industry |>
  itemise(year = "2012",
          pref_code = "1",
          city_code = "-",
          sic_code = "A") |>
  collect()

knitr::kable(power_for_industry)
```

## 不動産取引価格情報取得API

[![Lifecycle:
experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)

```{r}
trade <- webland_trade()
trade
```

```{r}
trade <- trade |> 
  itemise(from = "20201",
          to = "20201",
          pref_code = "01",
          city_code = "01101") |> 
  collect()

knitr::kable(trade[1:5, 1:6])
```

## 参考リンク

-   [Rで日本の統計データを効率的に取得しよう（e-Stat APIとjpstatパッケージで）](https://uchidamizuki.quarto.pub/blog/posts/2022/12/call-e-stat-api-in-r.html)
-   [Rで人口ピラミッドのアニメーションを作る](https://uchidamizuki.quarto.pub/blog/posts/2023/01/create-an-animation-of-a-population-pyramid-in-r.html)