Skip to content

capro-uio/nettskjemar

Repository files navigation

nettskjemar

R build status DOI Lifecycle: experimental CRAN status

The goal of {nettskjemar} is to have easy access to data and form information on the Nettskjema service by the University of Oslo, Norway. Currently the main possibilities is help in creating users and tokens for accessing Nettskjema through its API, downloading meta-data and codebooks about specific forms and data associated with a specific form.

Install the released version from CRAN with:

install.packages("nettskjemar")

Newer releases can be installed through the authors r-universe:

# Enable this universe
options(repos = c(
    lcbc_uio = 'https://lcbc-uio.r-universe.dev',
    CRAN = 'https://cloud.r-project.org'))

# Install some packages
install.packages('nettskjemar')

Install the development version from GitHub with:

# install.packages("remotes")
remotes::install_github("LCBC-UiO/nettskjemar")

Setting up the authentication

There is a tutorial on how to create the API access user and token needed to work with the api. This will need to be completed before you can access any other features of this package.

Example

Currently, the package contains functions to download data from forms, including submission answers, meta-data and codebook information. The most important, is the function that will download nettskjema submission data and return them as a tibble (data.frame). This needs only the id of a nettskjema, which can be found in the last part of the nettskjema url.

library(nettskjemar)

nettskjema_get_data(nettskjema_id)

If you do not have the codebook activated, or you want to use the full answers to questions rather than the coded ones, you can toggle off code book answers:

nettskjema_get_data(nettskjema_id, use_codebook = FALSE)

Documentation

Package documentation can be found on the associated GitHub pages, among other documentation on how to create the API access user and token.

Citation

To cite nettskjemar in publications use:

Athanasia Monika Mowinckel. (2021, May 10). LCBC-UiO/nettskjemar: v0.1.04 (Version v0.1.04). Zenodo. http://doi.org/10.5281/zenodo.4745481

A BibTeX entry for LaTeX users is

@Manual{, title = {nettskjemar - Package to work with University of Oslo Nettskjema API}, author = {Athanasia Mo Mowinckel}, year = {2021}, month = {05}, day = {10}, doi = {10.5281/zenodo.4745481}, }

Funding

This tool is partly funded by:

EU Horizon 2020 Grant: Healthy minds 0-100 years: Optimising the use of European brain imaging cohorts (Lifebrain).

Grant agreement number: 732592.

Call: Societal challenges: Health, demographic change and well-being