| Title: | Access the UNESCO Institute for Statistics API |
| Version: | 0.1.0 |
| Description: | Retrieve data from the UNESCO Institute for Statistics (UIS) API https://api.uis.unesco.org/api/public/documentation/. UIS provides public access to more than 4,000 indicators focusing on education, science and technology, culture, and communication. |
| License: | MIT + file LICENSE |
| Depends: | R (≥ 4.1) |
| Imports: | cli (≥ 3.0.0), httr2 (≥ 1.0.0), jsonlite (≥ 1.0.0), tibble, dplyr (≥ 1.0.0), tidyr (≥ 1.0.0), rlang (≥ 1.0.0) |
| Suggests: | curl, testthat (≥ 3.0.0) |
| URL: | https://github.com/tidy-intelligence/r-uisapi, https://tidy-intelligence.github.io/r-uisapi/ |
| BugReports: | https://github.com/tidy-intelligence/r-uisapi/issues |
| Config/testthat/edition: | 3 |
| Encoding: | UTF-8 |
| RoxygenNote: | 7.3.2 |
| NeedsCompilation: | no |
| Packaged: | 2025-03-04 18:47:42 UTC; krise |
| Author: | Christoph Scheuch 
[aut, cre, cph] |
| Maintainer: | Christoph Scheuch <christoph@tidy-intelligence.com> |
| Repository: | CRAN |
| Date/Publication: | 2025-03-06 16:50:01 UTC |
uisapi: Access the UNESCO Institute for Statistics API
Description
Retrieve data from the UNESCO Institute for Statistics (UIS) API https://api.uis.unesco.org/api/public/documentation/. UIS provides public access to more than 4,000 indicators focusing on education, science and technology, culture, and communication.
Author(s)
Maintainer: Christoph Scheuch christoph@tidy-intelligence.com (ORCID) [copyright holder]
See Also
Useful links:
Report bugs at https://github.com/tidy-intelligence/r-uisapi/issues
Get files available for download via UIS BDDS
Description
Retrieves information about files available in the UNESCO Institute for Statistics (UIS) Bulk Data Download Service (BDDS).
Usage
uis_bulk_files()
Value
A data frame with information about files:
file_name |
Character. The name of the data set. |
file_url |
Character. The URL of the data set. |
last_updated_description |
Character. Information about last update. |
Examples
# Download available files for bulk download
uis_bulk_files()
Get data from the UIS API
Description
Retrieves data from the UNESCO Institute for Statistics (UIS) API for specified entities, indicators, and time periods.
Usage
uis_get(
entities = NULL,
indicators = NULL,
start_year = NULL,
end_year = NULL,
version = NULL
)
Arguments
entities |
Character vector. The entity IDs (ISO 3166-1 alpha-3 codes)
to retrieve data for. Must provide either this parameter or |
indicators |
Character vector. The indicator IDs to retrieve data for.
Must provide either this parameter or |
start_year |
Numeric or character. The starting year for the data retrieval period. If NULL, no start year constraint is applied. |
end_year |
Numeric or character. The ending year for the data retrieval period. If NULL, no end year constraint is applied. |
version |
Character. The API version to use. If NULL, the default version is used. See uis_get_versions for a list of supported versions. |
Value
A data frame with the following columns:
entity_id |
Character. The ID of the entity (geoUnit). |
indicator_id |
Character. The ID of the indicator. |
year |
Numeric. The year of the observation. |
value |
Numeric. The value of the indicator for the given entity and year. |
Examples
# Get all data for a single indicator
uis_get(
indicators = "CR.1"
)
# Get all data for a single country
uis_get(
entities = "BRA"
)
# Get data for multiple indicators and countries
uis_get(
entities = c("BRA", "USA"),
indicators = c("CR.1", "CR.2")
)
# Get data for multiple indicators and countries and specific time range
uis_get(
entities = c("BRA", "USA"),
indicators = c("CR.1", "CR.2"),
start_year = 2010,
end_year = 2020
)
Get geographical entities from UIS API
Description
Retrieves information about geographical entities (countries, regions, etc.) available in the UNESCO Institute for Statistics (UIS) API.
Usage
uis_get_entities(version = NULL)
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. |
Value
A data frame with information about geographical entities:
entity_id |
Character. The unique identifier for the entity. |
entity_name |
Character. The name of the geographical entity. |
entity_type |
Character. The type of entity (e.g., country, region). |
region_group |
Character. Information about the region grouping. |
Examples
# Download entities for default version
uis_get_entities()
# Download entities for a specific version
uis_get_entities("20240910-b5ad4d82")
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)
Get available UIS API versions
Description
Retrieves information about the available versions of the UNESCO Institute for Statistics (UIS) API.
Usage
uis_get_versions(default_only = FALSE)
Arguments
default_only |
Logical. Indicates whether only the current default version should be retrievend. Defaults to FALSE. |
Value
A data frame with the following columns:
version |
Character. The version identifier. |
publication_date |
Date-time. The date when the version was released. |
description |
Character. The description of the version. |
theme |
List column. Each element is a nested data frame containing information about themes available in the version, with columns: theme_id, theme_last_update, theme_description |
Examples
uis_get_versions()