# Tutorial / vignette for the oenb R package

## Introduction

The `oenb` R packages provides tools to access statistical data via the web service of the Austrian central bank (Oesterreichische Nationalbank, OeNB).

## Installation

    install.packages("oenb")

### Development version

    # install.packages("devtools")
    devtools::install_github("franzmohr/oenb")

## Usage

    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.

    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.

    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.

    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.

    freq <- oenb_frequency(id = "11", pos = "VDBFKBSC217000")
    freq

### Data download

Series of a data set can be downloaded with the `oenb_data` function.

    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`.

    meta <- oenb_metadata(id = "11", pos = "VDBFKBSC217000")
    meta