estatapi

https://github.com/yutannihilation/estatapi
Admin
An R package that provides an interface to e-Stat API, the official statistics portal for the...
Tokens:3,911
Snippets:21
Trust Score:9.7
Update:4 months ago
Show doc for...
Tokens:
Raw
### Install estatapi Package

Source: https://github.com/yutannihilation/estatapi/blob/master/README.en.md

Installs the estatapi package from CRAN or the development version from GitHub.

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

```r
devtools::install_github("yutannihilation/estatapi")
```

--------------------------------

### Get Meta Information for a Dataset

Source: https://github.com/yutannihilation/estatapi/blob/master/README.en.md

Retrieves meta-information for a specific dataset (ID: '0003036792') in English. The function returns a list of tibbles, each containing meta-info for a column.

```r
meta_info <- estat_getMetaInfo(appId = appId, lang = "E", statsDataId = "0003036792")

names(meta_info)
#> [1] "tab"    "cat01"  "area"   "time"   ".names"

meta_info$cat01
#> # A tibble: 798 x 4
#>    `@code` `@name`                                        `@level` `@parentCode`
#>  * <chr>   <chr>                                          <chr>    <chr>        
#>  1 0001    "All items"                                    1        <NA>         
#>  2 0002    "Food"                                         1        <NA>         
#>  3 0003    "Cereals"                                      3        0002         
#>  4 0004    "Rice"                                         5        0003         
#>  5 1000    "Non-glutinous rice"                           6        0004         
#>  6 1001    "Rice-A(domestic), \"Koshihikari\""            7        1000         
#>  7 1002    "Rice-B(domestic), non-blended rice excluding… 7        1000         
#>  8 1011    "Glutinous rice"                               6        0004         
#>  9 0005    "Bread"                                        5        0003         
#> 10 1021    "White bread"                                  6        0005         
#> # … with 788 more rows
```

--------------------------------

### Get e-Stat API App ID

Source: https://github.com/yutannihilation/estatapi/blob/master/README.en.md

Stores your e-Stat API application ID. Registration on the e-Stat website is required to obtain an appId.

```r
appId <- "XXXXXXXXX"
```

--------------------------------

### Search Data Catalog

Source: https://github.com/yutannihilation/estatapi/blob/master/README.en.md

Finds statistical dataset files (Excel, CSV, PDF) and databases using `estat_getDataCatalog`. This function returns URLs to the files or databases, not the data itself. The example filters by search word and data type.

```r
catalog1 <- estat_getDataCatalog(appId = appId, lang = "E", searchWord = "beef", dataType = c("PDF", "XLS"))

catalog1[1, c("@id", "STAT_NAME", "TABLE_NAME", "SURVEY_DATE", "TABLE_SUB_CATEGORY1", "DATASET_NAME", "NAME", "LANDING_PAGE", "URL", "FORMAT")] %>%
  glimpse
#> Rows: 1
#> Columns: 10
#> $ `@id`               <chr> "000000680105"
#> $ STAT_NAME           <chr> "Retail price survey"
#> $ TABLE_NAME          <chr> "Monthly Prices and Annual Average Prices by Ite…
#> $ SURVEY_DATE         <chr> "2001"
#> $ TABLE_SUB_CATEGORY1 <chr> "[1201 Beef] - [1341 Hen eggs]"
#> $ DATASET_NAME        <chr> "Retail Price Survey (Trend Survey)_Yearly_2001"
#> $ NAME                <chr> "Statistical Tables_1_Monthly Prices and Annual …
#> $ LANDING_PAGE        <chr> "https://www.e-stat.go.jp/en/stat-search/files?l…
#> $ URL                 <chr> "https://www.e-stat.go.jp/en/stat-search/file-do…
#> $ FORMAT              <chr> "XLS"
```

--------------------------------

### Get Statistics Data

Source: https://github.com/yutannihilation/estatapi/blob/master/README.en.md

Fetches statistical data using the estat_getStatsData function. It's recommended to use additional conditions like cdCat01 to optimize queries. The output is a tibble containing the requested data.

```r
estat_getStatsData(
  appId = appId,
  lang = "E",
  statsDataId = "0003036792",
  cdCat01 = c("0005","1021")
)
#> Fetching record 1-8228... (total: 8228 records)
#> # A tibble: 8,228 x 11
#>    tab_code `Tabulated vari… cat01_code Items area_code AREA  time_code Time 
#>  * <chr>    <chr>            <chr>      <chr> <chr>     <chr> <chr>     <chr>
#>  1 1        Index            0005       Bread 13A01     Ku-a… 20160012… Dec.…
#>  2 1        Index            0005       Bread 13A01     Ku-a… 20160011… Nov.…
#>  3 1        Index            0005       Bread 13A01     Ku-a… 20160010… Oct.…
#>  4 1        Index            0005       Bread 13A01     Ku-a… 20160009… Sep.…
#>  5 1        Index            0005       Bread 13A01     Ku-a… 20160008… Aug.…
#>  6 1        Index            0005       Bread 13A01     Ku-a… 20160007… Jul.…
#>  7 1        Index            0005       Bread 13A01     Ku-a… 20160006… Jun.…
#>  8 1        Index            0005       Bread 13A01     Ku-a… 20160005… May …
#>  9 1        Index            0005       Bread 13A01     Ku-a… 20160004… Apr.…
#> 10 1        Index            0005       Bread 13A01     Ku-a… 20160003… Mar.…
#> # … with 8,218 more rows, and 3 more variables: unit <chr>, value <dbl>,
#> #   annotation <chr>
```

--------------------------------

### Fetch Statistics Data Partially

Source: https://github.com/yutannihilation/estatapi/blob/master/README.en.md

Retrieves statistical data in parts using `limit` and `startPosition` parameters. This is useful for handling large datasets. The `bind_rows` function can be used to combine the partial results.

```r
d1 <- estat_getStatsData(
        appId = appId, lang = "E", statsDataId = "0003036792", cdCat01 = c("0005","1021"),
        limit = 
      )
#> Fetching record 1-8228... (total: 8228 records)
```

```r
d2 <- estat_getStatsData(
        appId = appId, lang = "E", statsDataId = "0003036792", cdCat01 = c("0005","1021"),
        startPosition=101,
        limit = 3
      )
#> Fetching record 101-103... (total: 8228 records)
#> There are more records; please rerun with startPosition=201
```

```r
d <- bind_rows(d1, d2)
```

--------------------------------

### Search Datasets (Japanese)

Source: https://github.com/yutannihilation/estatapi/blob/master/README.en.md

Retrieves a list of datasets matching the search term 'chocolate' in Japanese. The result is returned as a tibble.

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

estat_getStatsList(appId = appId, searchWord = "chocolate")
#> # A tibble: 3 x 17
#>   `@id` STAT_NAME GOV_ORG STATISTICS_NAME TITLE CYCLE SURVEY_DATE OPEN_DATE
#> * <chr> <chr>     <chr>   <chr>           <chr> <chr> <chr>       <chr>    
#> 1 0002… 消費者物価指数… 総務省  平成17年基準消費者物価指数… 消費者物… -     0           2012-01-…
#> 2 0003… 消費者物価指数… 総務省  平成22年基準消費者物価指数… 消費者物… -     0           2017-01-…
#> 3 0003… 消費者物価指数… 総務省  2015年基準消費者物価指数… 消費者物… -     0           2020-03-…
#> # … with 9 more variables: SMALL_AREA <chr>, COLLECT_AREA <chr>,
#> #   MAIN_CATEGORY <chr>, SUB_CATEGORY <chr>, OVERALL_TOTAL_NUMBER <chr>,
#> #   UPDATED_DATE <chr>, TABULATION_CATEGORY <chr>, DESCRIPTION <chr>,
#> #   TABLE_NAME <chr>
```

--------------------------------

### Search Datasets (English)

Source: https://github.com/yutannihilation/estatapi/blob/master/README.en.md

Retrieves a list of datasets matching the search term 'chocolate' in English. Use `lang = "E"` for English results, but be aware that not all datasets are translated.

```r
estat_getStatsList(appId = appId, lang = "E", searchWord = "chocolate")
#> # A tibble: 3 x 17
#>   `@id` STAT_NAME GOV_ORG STATISTICS_NAME TITLE CYCLE SURVEY_DATE OPEN_DATE
#> * <chr> <chr>     <chr>   <chr>           <chr> <chr> <chr>       <chr>    
#> 1 0002… Consumer… Minist… 2005-Base Cons… 2005… -     0           2012-01-…
#> 2 0003… Consumer… Minist… 2010-Base Cons… 2010… -     0           2017-01-…
#> 3 0003… Consumer… Minist… 2015-Base Cons… 2015… -     0           2020-03-…
#> # … with 9 more variables: SMALL_AREA <chr>, COLLECT_AREA <chr>,
#> #   MAIN_CATEGORY <chr>, SUB_CATEGORY <chr>, OVERALL_TOTAL_NUMBER <chr>,
#> #   UPDATED_DATE <chr>, TABULATION_CATEGORY <chr>, DESCRIPTION <chr>,
#> #   TABLE_NAME <chr>
```

--------------------------------

### estat_getDataCatalog

Source: https://github.com/yutannihilation/estatapi/blob/master/README.en.md

Finds statistical dataset files (Excel, CSV, PDF) and databases. Returns URLs for these resources.

```APIDOC
## estat_getDataCatalog

### Description
Searches for statistical dataset files and databases, returning their URLs. Note that the data itself is not directly accessible via the API.

### Method
Not applicable (R function)

### Parameters
- **appId** (string) - Required - Application ID.
- **lang** (string) - Optional - Language code (e.g., "E" for English).
- **searchWord** (string) - Optional - A word to search for within dataset names or descriptions.
- **dataType** (array of strings) - Optional - Filters results by data type (e.g., "PDF", "XLS", "CSV").

### Request Example
```r
estat_getDataCatalog(appId = appId, lang = "E", searchWord = "beef", dataType = c("PDF", "XLS"))
```

### Response
Returns a data frame containing catalog information for the found datasets. Key fields include `@id`, `STAT_NAME`, `TABLE_NAME`, `SURVEY_DATE`, `TABLE_SUB_CATEGORY1`, `DATASET_NAME`, `NAME`, `LANDING_PAGE`, `URL`, and `FORMAT`.

### Response Example
```r
# A tibble: 1 x 10
  `@id`    STAT_NAME           TABLE_NAME                                     SURVEY_DATE TABLE_SUB_CATEGORY1 DATASET_NAME                       NAME                                                                LANDING_PAGE                                                                    URL                                                                             FORMAT
  <chr>    <chr>               <chr>                                            <chr>       <chr>               <chr>                                <chr>                                                               <chr>                                                                           <chr>                                                                           <chr>
1 000000680105 Retail price survey "Monthly Prices and Annual Average Prices by Ite… 2001        [1201 Beef] - [1341 Hen eggs]      Retail Price Survey (Trend Survey)_Yearly_2001  Statistical Tables_1_Monthly Prices and Annual … https://www.e-stat.go.jp/en/stat-search/files?l=0&cycle=1&stat=000000680105&pageID=0&metadata=1&dataid=A000000680105&stat_infomation=1 https://www.e-stat.go.jp/en/stat-search/file-download?stat=000000680105&fileid=000000680105_1&cycle=1&download=1 XLS
```
```

--------------------------------

### estat_getStatsData

Source: https://github.com/yutannihilation/estatapi/blob/master/README.en.md

Retrieves statistical data based on specified application ID and statistics data ID. It supports filtering by various categories and pagination using limit and startPosition.

```APIDOC
## estat_getStatsData

### Description
Get statistics data using the e-Stat API. Requires `appId` and `statsDataId`. Additional parameters can be used for filtering and pagination.

### Method
Not applicable (R function)

### Parameters
- **appId** (string) - Required - Application ID.
- **lang** (string) - Optional - Language code (e.g., "E" for English).
- **statsDataId** (string) - Required - The ID of the statistics dataset.
- **cdCat01** (array of strings) - Optional - Category codes for filtering.
- **limit** (integer) - Optional - Number of records to retrieve per request.
- **startPosition** (integer) - Optional - The starting position for retrieving records.

### Request Example
```r
estat_getStatsData(
  appId = appId,
  lang = "E",
  statsDataId = "0003036792",
  cdCat01 = c("0005","1021")
)
```

### Response
Returns a tibble (data frame) containing the requested statistical data. Columns include `tab_code`, `Tabulated vari...`, `cat01_code`, `Items`, `area_code`, `AREA`, `time_code`, `Time`, `unit`, `value`, and `annotation`.

### Response Example
```r
# A tibble: 8,228 x 11
   tab_code `Tabulated vari… cat01_code Items area_code AREA  time_code Time 
 * <chr>    <chr>            <chr>      <chr> <chr>     <chr> <chr>     <chr>
 1 1        Index            0005       Bread 13A01     Ku-a… 20160012… Dec.…
 2 1        Index            0005       Bread 13A01     Ku-a… 20160011… Nov.…
 # ... (truncated for brevity)
```
```
Tokens:
Raw