README.md

In rOpenGov/vipunen: Client Package for Vipunen API

vipunen

vipunen is a client package for Vipunen, the education administration's reporting portal. The Ministry of Education and Culture and the Finnish National Agency for Education are jointly responsible for the content on Vipunen, but have nothing to do with this R package.

Statistical data from Vipunen is also machine readable through a REST/JSON API. The API was opened in August 2017 and is currently still in development phase. In this first phase, the content is moslty related to the data collected from universities.

All data available through the API is licensed under Creative Commons Attribution 4.0 (CC BY 4.0). To cite the data, please use the following format:

(in Finnish) Vipunen - opetushallinnon tilastopalvelu: Raportin nimi. Tietolähde. Saantitapa: Vipunen-rajapinta [Viitattu pvm]

(in English) Vipunen - Educational Statistics Finland: Report name. Source. Acquired from: Vipunen API [Date cited]

TBA: citation example

For further details about the API (in Finnish only), please see:

https://vipunen.fi/fi-fi/Sivut/Vipunen-API

Installation

vipunen is not yet on CRAN, but you can install it from GitHub with:

install.packages("remotes")
remotes::install_github("ropengov/vipunen")

Example

This is a basic example which shows you how to solve a common problem:

## basic example code

Contributors

• Joona Lehtomäki [e-mail], package maintainer
• Vilppu Välimäki, logo design

rOpenGov/vipunen documentation built on Oct. 14, 2021, 1:32 p.m.