README.md 2.42 KB
Newer Older
Sébastien Galais's avatar
Sébastien Galais committed
1
# rdbnomics <img src="man/figures/logo.png" align="right" width="120" />
2

Sébastien Galais's avatar
Sébastien Galais committed
3
[![CRAN\_Status\_Badge](http://www.r-pkg.org/badges/version/rdbnomics)](https://cran.r-project.org/package=rdbnomics)
4
[![](http://cranlogs.r-pkg.org/badges/grand-total/rdbnomics)](https://cran.r-project.org/package=rdbnomics)
5 6
[![pipeline status](https://git.nomics.world/dbnomics/rdbnomics/badges/master/pipeline.svg)](https://git.nomics.world/dbnomics/rdbnomics/commits/master)
[![status](https://tinyverse.netlify.com/badge/rdbnomics)](https://CRAN.R-project.org/package=rdbnomics)
7 8

## DBnomics R client
Christophe Benz's avatar
Christophe Benz committed
9

Sébastien Galais's avatar
Sébastien Galais committed
10
This package provides you access to DBnomics data series. DBnomics is an open-source project with the goal of aggregating the world's economic data in one location, free of charge to the public. DBnomics covers hundreds of millions of series from international and national institutions (Eurostat, World Bank, IMF, ECB, ...).
Thomas Brand's avatar
Thomas Brand committed
11

12
To use this package, you have to provide the codes of the provider, dataset and series you want. You can retrieve them directly on the <a href="https://db.nomics.world/" target="_blank">website</a>. You have access to the API through this <a href="http://api.db.nomics.world/" target="_blank">link</a> and the documentation is <a href="https://api.db.nomics.world/v22/apidocs" target="_blank">here</a>.
Thomas Brand's avatar
Thomas Brand committed
13

14
DBnomics is hosted on its own <a href="https://git.nomics.world/" target="_blank">gitlab platform</a>. However, in order to install the package more easily, we created a mirror of this package on <a href="https://github.com/dbnomics/rdbnomics" target="_blank">github</a>.
Thomas Brand's avatar
Thomas Brand committed
15

16
To install `rdbnomics` from CRAN:
Thomas Brand's avatar
Thomas Brand committed
17 18

```r
19
install.packages("rdbnomics")
Thomas Brand's avatar
Thomas Brand committed
20
library(rdbnomics)
Thomas Brand's avatar
Thomas Brand committed
21 22
```

23
To install `rdbnomics` from github:
24 25

```r
26
remotes::install_github("dbnomics/rdbnomics", build_vignettes = TRUE, force = TRUE)
27 28 29
library(rdbnomics)
```

30
After installation, a vignette is available to the user with:
31

32 33 34 35 36
* many examples,
* how to configure a proxy,
* how to use default R internet connection,
* transform time series with filters,
* ...
37

38
Just follow the link <a href="https://CRAN.R-project.org/package=rdbnomics/vignettes/rdbnomics.html" target="_blank">rdbnomics</a> or run:
39
```r
40
vignette("rdbnomics")
41
```
42
A lot of examples are available in the functions' documentations:
43
```r
44 45 46 47 48 49 50 51
?rdb
?rdb_datasets
?rdb_dimensions
?rdb_series
?rdb_providers
?rdb_last_updates
?rdb_to_xts
?rdb_rename_xts
52 53
```

54 55
## P.S.
Visit <a href="https://db.nomics.world/" target="_blank">https://db.nomics.world/</a> !