Package {dashboardapi}

dashboardapi: Japan's Statistics Dashboard data for R

Description

dashboardapi is an unofficial, independently developed client for the Statistics Dashboard Web API provided by the Statistics Bureau of Japan. It is not affiliated with, endorsed by, or maintained by the Statistics Bureau. A typical workflow is:

Details

1. Find a series with dashboard_search().

2. Find region codes with dashboard_regions().

3. Retrieve observations with dashboard_data().

No registration or API key is required. The API documentation asks clients not to create a large volume of access in a short period. When dashboard_data() must split a request into multiple API calls, the package therefore waits at least one second between calls.

Package options

• dashboardapi.lang: default response language, "en" or "jp".

• dashboardapi.wait: seconds between automatically batched requests; default and enforced minimum 1.

• dashboardapi.timeout: request timeout in seconds; default 30.

• dashboardapi.retries: retries for transient failures; default 3.

Terms of use

When publishing content retrieved with this package, cite the Statistics Dashboard as the source. When publishing edited content, also identify the editing entity. Services published using the API should show the credit requested by the Statistics Dashboard. Call dashboard_api_credit() for the source citation, edited-content template, API credit, and official links. The package's MIT license applies only to original package code and documentation; it does not relicense government or third-party data, metadata, or official texts. Check any individual rights statement before reusing third-party content.

Author(s)

Maintainer: Kenji Miyazaki kenjimyzk@gmail.com

Authors:

• Kenji Miyazaki kenjimyzk@gmail.com

See Also

Statistics Dashboard API

Return Statistics Dashboard attribution and API credit

Description

The Statistics Dashboard asks users of its content to cite the source. When publishing edited content, identify the editing entity as well. Publishers of services using the API must also show a specified credit. The terms can change, so verify the linked official page before publication.

Usage

dashboard_api_credit(lang = c("en", "jp"))

Arguments

Value

A named list containing source (the required source citation), processed (a template for edited content), credit (the required API service credit), and official URLs.

Examples

dashboard_api_credit("en")
dashboard_api_credit("jp")$credit

Return commonly used Statistics Dashboard API codes

Description

The API's full category, survey, and region code systems are maintained by the Statistics Bureau. This helper returns the small enumerations used directly by package arguments.

Usage

dashboard_codes(
  type = c("cycle", "regional_rank", "seasonal", "provisional", "social_event_level"),
  lang = c("en", "jp")
)

Arguments

Value

A tibble containing code, name, and type.

Examples

dashboard_codes("cycle")
dashboard_codes("regional_rank", lang = "jp")

Retrieve Statistics Dashboard observations

Description

dashboard_data() retrieves one or more indicators and returns one indicator-region-time observation per row. The API permits five indicators and 50 regions per request. Longer vectors are split automatically, with at least one second between requests.

Usage

dashboard_data(
  indicator_code,
  region_code = NULL,
  parent_region_code = NULL,
  region_level = NULL,
  time = NULL,
  time_from = NULL,
  time_to = NULL,
  cycle = NULL,
  regional_rank = NULL,
  seasonal = NULL,
  stat_name = NULL,
  value_condition = NULL,
  wide = FALSE,
  lang = dash_default("lang", "en"),
  wait = dash_default("wait", 1),
  timeout = dash_default("timeout", 30),
  retries = dash_default("retries", 3)
)

Arguments

Details

Named indicator_code vectors create aliases in the indicator column and in wide output, following the style of WDI::WDI().

Value

A tibble. Long output retains raw codes and labels, an R Date, numeric value, original value_raw, and annotations.

Examples

## Not run: 
population <- dashboard_data(
  indicator_code = c(population = "0201010000000010000"),
  region_code = "00000",
  time_from = "2020CY00",
  time_to = "2024CY00",
  cycle = "year",
  regional_rank = "japan",
  seasonal = "original"
)

## End(Not run)

Search and retrieve social-event metadata

Description

Search and retrieve social-event metadata

Usage

dashboard_events(
  time = NULL,
  time_from = NULL,
  time_to = NULL,
  level = NULL,
  category = NULL,
  modified_from = NULL,
  modified_to = NULL,
  lang = dash_default("lang", "en"),
  timeout = dash_default("timeout", 30),
  retries = dash_default("retries", 3)
)

Arguments

Value

A tibble with one row per event-category association.

Examples

## Not run: 
dashboard_events(category = "0201", level = "high")

## End(Not run)

Search and retrieve indicator metadata

Description

This is the discovery endpoint for Statistics Dashboard series. The result has one row per indicator element: an indicator split by data cycle, regional rank, and original/seasonally adjusted status.

Usage

dashboard_indicators(
  query = NULL,
  indicator_code = NULL,
  category = NULL,
  time = NULL,
  time_from = NULL,
  time_to = NULL,
  cycle = NULL,
  regional_rank = NULL,
  seasonal = NULL,
  stat_code = NULL,
  stat_name = NULL,
  modified_from = NULL,
  modified_to = NULL,
  lang = dash_default("lang", "en"),
  timeout = dash_default("timeout", 30),
  retries = dash_default("retries", 3)
)

Arguments

Value

A tibble with one row per indicator element.

Examples

## Not run: 
dashboard_indicators(query = "Total population", lang = "en")
dashboard_indicators(
  category = "0201", cycle = "year", regional_rank = "prefecture"
)

## End(Not run)

Search and retrieve region metadata

Description

Search and retrieve region metadata

Usage

dashboard_regions(
  query = NULL,
  region_code = NULL,
  parent_region_code = NULL,
  time = NULL,
  time_from = NULL,
  time_to = NULL,
  region_level = NULL,
  modified_from = NULL,
  modified_to = NULL,
  lang = dash_default("lang", "en"),
  timeout = dash_default("timeout", 30),
  retries = dash_default("retries", 3)
)

Arguments

Value

A tibble of regions and their parent regions.

Examples

## Not run: 
dashboard_regions(parent_region_code = "00000")
dashboard_regions(query = "Tokyo", lang = "en")

## End(Not run)

Search Statistics Dashboard indicators

Description

A concise alias for dashboard_indicators() with a required search phrase.

Usage

dashboard_search(query, lang = dash_default("lang", "en"), ...)

Arguments

Value

A tibble with one row per matching indicator element.

Examples

## Not run: 
dashboard_search("unemployment rate")
dashboard_search(intToUtf8(c(23436, 20840, 22833, 26989, 29575)), lang = "jp")

## End(Not run)

Search and retrieve statistical-survey metadata

Description

Search and retrieve statistical-survey metadata

Usage

dashboard_surveys(
  query = NULL,
  indicator_code = NULL,
  stat_code = NULL,
  modified_from = NULL,
  modified_to = NULL,
  lang = dash_default("lang", "en"),
  timeout = dash_default("timeout", 30),
  retries = dash_default("retries", 3)
)

Arguments

Value

A tibble of statistical surveys.

Examples

## Not run: 
dashboard_surveys(query = "Population Census", lang = "en")

## End(Not run)

Search and retrieve statistical term metadata

Description

Search and retrieve statistical term metadata

Usage

dashboard_terms(
  query = NULL,
  category = NULL,
  indicator_code = NULL,
  stat_code = NULL,
  modified_from = NULL,
  modified_to = NULL,
  lang = dash_default("lang", "en"),
  timeout = dash_default("timeout", 30),
  retries = dash_default("retries", 3)
)

Arguments

Value

A tibble of statistical terms and definitions.

Examples

## Not run: 
dashboard_terms(category = "0201", lang = "en")
dashboard_terms(query = intToUtf8(c(20154, 21475)), lang = "jp")

## End(Not run)