Skip to contents

Data access

Download data and metadata from the Kolada API.

get_values()
Get data from Kolada
get_metadata()
Download metadata from the Kolada API
get_kpi() get_kpi_groups() get_ou() get_municipality() get_municipality_groups()
Download metadata for a specific entity from the Kolada API

Search and filter

Search and filter metadata tables.

kpi_search()
Search for Kolada KPIs using a Kolada KPI table
municipality_search()
Search a Kolada municipality metadata table
ou_search()
Search a Kolada Organizational Unit metadata table
kpi_grp_search()
Search a Kolada KPI Group metadata table for group names
municipality_grp_search()
Search a Kolada Municipality Group metadata table for group names

Describe

Human-readable descriptions of metadata.

kpi_describe()
Describe the KPIs in a Kolada KPI metadata table
kpi_grp_describe()
Describe the KPIs in a Kolada KPI Group metadata table
municipality_grp_describe()
Describe the municipalitie in a Kolada Municipality Group metadata table

Transform

Simplify and reshape metadata and data.

kpi_minimize()
Simplify a KPI table
kpi_bind_keywords()
Add keyword columns to a Kolada KPI table
values_minimize()
Simplify a Kolada values table
values_legend()
Create KPI long-form descriptions to add to a plot
kpi_grp_unnest()
Create a KPI table from a Kolada KPI Group metadata table
municipality_grp_unnest()
Create a municipality table from a Kolada Municipality Group metadata table

Extract IDs

Extract ID vectors for use with get_values().

kpi_extract_ids()
Extract a vector of KPI ID strings from a Kolada KPI metadata table
municipality_extract_ids()
Extract a vector of municipality ID strings from a Kolada municipality table
kpi_grp_extract_ids()
Extract KPI ID strings from a Kolada KPI Group metadata table
municipality_grp_extract_ids()
Extract municipality ID strings from a Kolada municipality group table
municipality_name_to_id()
Convert a vector of municipality names to municipality ids
municipality_id_to_name()
Convert a vector of municipality ids to municipality names

Query building

Compose API query URLs.

compose_metadata_query()
Compose a query to fetch metadata from the Kolada API.
compose_data_query()
Compose a query to fetch metadata from the Kolada API. Its use is mainly

Utilities

API availability, caching, and other helpers.

kolada_available()
Check if the Kolada API is available
kolada_cache_dir()
Get the rKolada cache directory
kolada_clear_cache()
Clear the rKolada cache
allowed_entities()
Allowed entities: Kolada metadata classes