download_indicators: Download World Bank indicator data for specific countries and...

In wdi2: Download World Development Indicators from the World Bank Indicators API

Download World Bank indicator data for specific countries and multiple indicators

Description

This function retrieves indicator data from the World Bank API for a specified set of countries and indicators. The user can specify one or more indicators, a date range, and other options to tailor the request. The data is processed and returned in a tidy format, including country, indicator, date, and value fields.

Usage

download_indicators(
  countries,
  indicators,
  start_date = NULL,
  end_date = NULL,
  language = "en",
  per_page = 1000,
  progress = TRUE
)

Arguments

countries	A character vector of ISO 2-country codes, or "all" to retrieve data for all countries.
indicators	A character vector specifying one or more World Bank indicators to download (e.g., c("NY.GDP.PCAP.KD", "SP.POP.TOTL")).
start_date	Optional. The starting date for the data, either as a year (e.g., 2010) or a specific month (e.g., "2012M01").
end_date	Optional. The ending date for the data, either as a year (e.g., 2020) or a specific month (e.g., "2012M05").
language	A character string specifying the language for the request, see list_supported_languages. Defaults to "en".
per_page	An integer specifying the number of results per page for the API. Defaults to 1000.
progress	A logical value indicating whether to show progress messages during the data download and parsing. Defaults to TRUE.

Details

This function constructs a request URL for the World Bank API, retrieves the relevant data for the given countries and indicators, and processes the response into a tidy format. The user can optionally specify a date range, and the function will handle requests for multiple pages if necessary. If the progress parameter is TRUE, messages will be displayed during the request and parsing process.

The function supports downloading multiple indicators by sending individual API requests for each indicator and then combining the results into a single tidy data frame.

Value

A tibble containing the indicator data for the specified countries and indicators. The following columns are included:

indicator_id

The ID of the indicator (e.g., "NY.GDP.PCAP.KD").

country_id

The ISO 2-country code of the country for which the data was retrieved.

date

The date of the indicator data (either a year or month depending on the request).

value

The value of the indicator for the given country and date.

Examples

# Download single indicator for multiple countries
download_indicators(c("US", "CA", "GB"), "NY.GDP.PCAP.KD")

# Download single indicator for a specific time frame
download_indicators(c("US", "CA", "GB"), "DPANUSSPB", start_date = 2012, end_date = 2013)

# Download single indicator for different frequency
download_indicators(c("MX", "CA", "US"), "DPANUSSPB", start_date = "2012M01", end_date = "2012M05")


# Download single indicator for all countries and disable progress bar
download_indicators("all", "NY.GDP.PCAP.KD", progress = FALSE)

# Download multiple indicators for multiple countries
download_indicators(c("US", "CA", "GB"), c("NY.GDP.PCAP.KD", "SP.POP.TOTL"))

wdi2 documentation built on Sept. 13, 2024, 1:12 a.m.