Learn R Programming

rKolada

rKolada is an R package for downloading, inspecting and processing data from Kolada, an open database containing over 4,000 Key Performance Indicators for Swedish municipalities and regions.

To learn more about using rKolada, it is recommended you use the following resources in order:

Getting started with rKolada

  1. To get up and running quickly with rKolada, please see the vignette A quick start guide to rKolada.
  2. For an introduction to rKolada and the design principles of functions included, please see Introduction to rKolada.
  3. See the Reference section of the package homepage to learn about the full set of functionality included with the package.

rKolada is open source licensed under the Affero Gnu Public License version 3. This means you are free to download the source, modify and redistribute it as you please, but any copies or modifications must retain the original license. Please see the file LICENSE.md for further information.

Installation

rKolada is on CRAN. To install it, run the following code in R:

install.packages("rKolada")

To install the latest development version from GitHub, use the remotes package:

library("remotes")
remotes::install_github("LCHansson/rKolada")

Contributing

You are welcome to contribute to the further development of the rKolada package in any of the following ways:

  • Open an issue
  • Clone this repo, make modifications and create a pull request
  • Spread the word!

Code of Conduct

Please note that the rKolada project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.

Copy Link

Version

Install

install.packages('rKolada')

Monthly Downloads

214

Version

0.2.3

License

AGPL-3

Issues

Pull Requests

Stars

Forks

Maintainer

Love Hansson

Last Published

May 14th, 2024

Functions in rKolada (0.2.3)

kpi_grp_extract_ids

Extract KPI ID strings from a Kolada KPI Group metadata table
municipality_grp_describe

Describe the municipalitie in a Kolada Municipality Group metadata table
municipality_grp_extract_ids

Extract municipality ID strings from a Kolada municipality group table
municipality_id_to_name

Convert a vector of municipality ids to municipality names
municipality_name_to_id

Convert a vector of municipality names to municipality ids
municipality_extract_ids

Extract a vector of municipality ID strings from a Kolada municipality table
kpi_search

Search for Kolada KPIs using a Kolada KPI table
values_minimize

Simplify a Kolada values table
municipality_grp_search

Search a Kolada Municipality Group metadata table for group names
municipality_grp_unnest

Create a municipality table from a Kolada Municipality Group metadata table
kpi_grp_search

Search a Kolada KPI Group metadata table for group names
kpi_grp_describe

Describe the KPIs in a Kolada KPI Group metadata table
kpi_extract_ids

Extract a vector of KPI ID strings from a Kolada KPI metadata table
%>%

re-export magrittr pipe operator
kpi_describe

Describe the KPIs in a Kolada KPI metadata table
values_legend

Create KPI long-form descriptions to add to a plot
municipality_search

Search a Kolada municipality metadata table
kpi_minimize

Simplify a KPI table
kpi_grp_unnest

Create a KPI table from a Kolada KPI Group metadata table
ou_search

Search a Kolada Organizational Unit metadata table
generate_kpi_metadata

Generate KPI metadata from a Kolada KPI object
get_kpi

Download metadata for a specific entity from the Kolada API
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
allowed_entities

Allowed entities: Kolada metadata classes
kolada_available

Check if the Kolada API is available
kpi_bind_keywords

Add keyword columns to a Kolada KPI table
get_metadata

Download metadata from the Kolada API
get_values

Get data from Kolada