uis_get_indicators {uisapi}R Documentation

Get indicator definitions from UIS API

Description

Retrieves information about indicators available in the UNESCO Institute for Statistics (UIS) API.

Usage

uis_get_indicators(
  version = NULL,
  disaggregations = FALSE,
  glossary_terms = FALSE
)

Arguments

version

Character. The API version to use. If NULL (default), the API's default version will be used. See uis_get_versions for a list of supported versions.

disaggregations

Logical. If TRUE, includes disaggregation information for indicators. Default is FALSE.

glossary_terms

Logical. If TRUE, includes glossary terms associated with indicators. Default is FALSE.

Value

A data frame with information about indicators:

indicator_id

Character. The unique identifier for the indicator.

indicator_name

Character. The name of the indicator.

theme

Character. The theme of the indicator.

last_data_update

Date. The last update date.

last_data_update_description

Character. A description about the last update date.

data_availability

List column. Contains nested information about data availability, including total record count and timeline min/max years.

entity_types

List column. Contains information about entity types associated with the indicator.

Examples


# Download indicators
uis_get_indicators()

# Download indicators with glossary terms and disaggregations
uis_get_indicators(disaggregations = TRUE, glossary_terms = TRUE)



[Package uisapi version 0.1.0 Index]