There are five different types of metadata entities in the Kolada database:
"kpi", "kpi_groups", "municipality", "municipality_groups", and "ou". For
every entity there is a corresponding function get_ENTITY
which
retrieves a table with the metadata for that entity. The get_ENTITY
functions are thin wrappers around get_metadata
.
get_kpi(
id = NULL,
max_results = NULL,
cache = FALSE,
cache_location = tempdir,
verbose = FALSE
)
get_kpi_groups(
id = NULL,
cache = FALSE,
max_results = NULL,
cache_location = tempdir,
verbose = FALSE
)
get_ou(
id = NULL,
municipality = NULL,
max_results = NULL,
cache = FALSE,
cache_location = tempdir,
verbose = FALSE
)
get_municipality(
id = NULL,
cache = FALSE,
max_results = NULL,
cache_location = tempdir,
verbose = FALSE
)
get_municipality_groups(
id = NULL,
cache = FALSE,
max_results = NULL,
cache_location = tempdir,
verbose = FALSE
)
(Optional) One or several KPI IDs
(Optional) Specify the maximum number of results returned by the query.
Logical. If TRUE, downloaded data are stored to the local disk
in the place specified by cache_location
. If data is already present
on the local disk, this data is returned instead of downloading data from
the API.
Where to store and search for cached data. Can be a
path to a directory or the name of any function that returns the path to a
directory when called, like getwd
. Defaults to
tempdir
.
Whether to print the call to the Kolada API as a message to the R console.
(Optional) A string or vector of strings containing municipality codes. If getting OU data, you can use this parameter to narrow the search.
Returns a tibble with metadata for the specified entity. In rKolada
terminology, a table returned by e.g. get_kpi
is referred to
as a kpi_df
and can be passed to functions starting with "kpi" such
as kpi_bind_keywords
.
# Download KPI table and store a cache copy of the results in a temporary folder
# (to actually download all available data, don't specify max_results)
kpi_df <- get_kpi(cache = TRUE, max_results = 100)