-
Notifications
You must be signed in to change notification settings - Fork 1
/
README.Rmd
93 lines (65 loc) · 3.38 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# nettskjemar <img src='man/figures/logo.png' align="right" height="138.5" />
<!-- badges: start -->
[](https://github.com/LCBC-UiO/nettskjemar/actions)
[](https://zenodo.org/badge/latestdoi/206264675)
[](https://lifecycle.r-lib.org/articles/stages.html)
[](https://CRAN.R-project.org/package=nettskjemar)
<!-- badges: end -->
The goal of {nettskjemar} is to have easy access to data and form information on the [Nettskjema](https://nettskjema.no/) service by the [University of Oslo, Norway](https://www.uio.no/english/).
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:
```{r, eval = FALSE}
install.packages("nettskjemar")
```
Newer releases can be installed through the authors r-universe:
```{r, eval = FALSE}
# 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](https://github.com/) with:
```{r, eval = FALSE}
# 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](https://lcbc-uio.github.io/nettskjemar/articles/auth_setup.html) 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.
```{r example, eval=FALSE}
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:
```{r, eval=FALSE}
nettskjema_get_data(nettskjema_id, use_codebook = FALSE)
```
## Documentation
Package documentation can be found on the associated [GitHub pages](https://lcbc-uio.github.io/nettskjemar/), among other documentation on [how to create the API access user and token](https://lcbc-uio.github.io/nettskjemar/articles/auth_setup.html).
# Citation
```{r echo = FALSE, results='asis'}
citation("nettskjemar")
```
# 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