-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.Rmd
90 lines (62 loc) · 2.23 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
---
output: github_document
---
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# oenb
[](https://cran.r-project.org/package=oenb)
[](https://github.com/franzmohr/oenb/actions)
The `oenb` R package provides tools to access statistical data via the [web service of the Austrian central bank](https://www.oenb.at/en/Statistics/User-Defined-Tables/webservice.html) (Oesterreichische Nationalbank, OeNB).
## Installation
```{r, eval = FALSE}
install.packages("oenb")
```
### Development version
```{r, eval = FALSE}
# install.packages("devtools")
devtools::install_github("franzmohr/oenb")
```
## Usage
```{r}
library("oenb")
```
### Table of contents
A table of available data sets can be obtained with the function `oenb_toc`. Its output contains the ID of the data set with a short description.
```{r}
toc <- oenb_toc()
head(toc)
```
### Dataset overview
Each data set contains a series of indicators. The function `oenb_dataset` can be used to obtain a table of available series for a given data set. Its output contains the position code of a series and a short description.
```{r}
overview <- oenb_dataset(id = "11")
head(overview)
```
### Attributes of a series
Many series are available in different forms. The function `oenb_attributes` obtains a table of available query specifications of a given series.
```{r}
attrib <- oenb_attributes(id = "11", pos = "VDBFKBSC217000")
attrib
```
Furthermore, series are available in different frequencies. The function `oenb_frequency` can be used to obtain the available frequencies of a given series and the periods, for which data are available.
```{r}
freq <- oenb_frequency(id = "11", pos = "VDBFKBSC217000")
freq
```
### Data download
Series of a data set can be downloaded with the `oenb_data` function.
```{r}
series <- oenb_data(id = "11", pos = "VDBFKBSC217000", attr = c("dval3" = "AT"))
```
### Metadata
Metadata on a specific series can be obtained with the function `oenb_metadata`.
```{r}
meta <- oenb_metadata(id = "11", pos = "VDBFKBSC217000")
meta
```