-
Notifications
You must be signed in to change notification settings - Fork 2
/
README.Rmd
219 lines (169 loc) · 6.9 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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
tidy = "styler",
comment = "#>",
fig.path = "man/figures/README-",
warning = FALSE,
message = FALSE,
dev = "ragg_png",
dpi = 300,
out.width = "100%"
)
```
# tidyBdE <img src="man/figures/logo.png" align="right" width="120"/>
<!-- badges: start -->
[](https://ropenspain.es/)
[](https://CRAN.R-project.org/package=tidyBdE)
[](https://cran.r-project.org/web/checks/check_results_tidyBdE.html)
[](https://cran.r-project.org/package=tidyBdE)
[](https://cran.r-project.org/web/checks/check_results_tidyBdE.html)
[](https://ropenspain.r-universe.dev/tidyBdE)
[](https://github.com/rOpenSpain/tidyBdE/actions/workflows/check-full.yaml)
[](https://github.com/rOpenSpain/tidyBdE/actions/workflows/rhub.yaml)
[](https://app.codecov.io/gh/ropenspain/tidyBdE)
[](https://www.codefactor.io/repository/github/ropenspain/tidybde)
[](https://doi.org/10.32614/CRAN.package.tidyBdE)
[](https://www.repostatus.org/#active)
<!-- badges: end -->
**tidyBdE** is an API package that helps to retrieve data from [Banco de
España](https://www.bde.es/webbe/en/estadisticas/recursos/descargas-completas.html).
The data is returned as a [`tibble`](https://tibble.tidyverse.org/) and the
package tries to guess the format of every time-series (dates, characters and
numbers).
## Installation
Install **tidyBdE** from [**CRAN**](https://CRAN.R-project.org/package=tidyBdE):
```{r, eval = FALSE}
install.packages("tidyBdE")
```
You can install the developing version of **tidyBdE** with:
```{r, eval = FALSE}
remotes::install_github("ropenspain/tidyBdE")
```
Alternatively, you can install the developing version of **tidyBdE** using the
[r-universe](https://ropenspain.r-universe.dev/tidyBdE):
```{r, eval = FALSE}
# Install tidyBdE in R:
install.packages("tidyBdE", repos = c(
"https://ropenspain.r-universe.dev",
"https://cloud.r-project.org"
))
```
## Examples
Banco de España (**BdE**) provides several time-series, either produced by the
institution itself or compiled for another sources, as
[Eurostat](https://ec.europa.eu/eurostat) or [INE](https://www.ine.es/).
The basic entry point for searching time-series are the catalogs (*indexes*) of
information. You can search any series by name:
```{r search, message=FALSE}
library(tidyBdE)
# Load tidyverse for better handling
library(ggplot2)
library(dplyr)
library(tidyr)
# Search GBP on "TC" (exchange rate) catalog
XR_GBP <- bde_catalog_search("GBP", catalog = "TC")
XR_GBP %>%
select(Numero_secuencial, Descripcion_de_la_serie) %>%
# To table on document
knitr::kable()
```
**Note that BdE files are only provided in Spanish, for the time being**, the
organism is working on the English version. By now, search terms should be
provided in Spanish in order to get search results.
After we have found our series, we can load the series for the GBP/EUR exchange
rate using the sequential number reference (`Numero_Secuencial`) as:
```{r find}
seq_number <- XR_GBP %>%
# First record
slice(1) %>%
# Get id
select(Numero_secuencial) %>%
# Convert to num
as.double()
# Extract series
time_series <- bde_series_load(seq_number, series_label = "EUR_GBP_XR") %>%
filter(Date >= "2010-01-01" & Date <= "2020-12-31") %>%
drop_na()
```
### Plots
The package also provides a custom **ggplot2** theme based on the publications
of BdE:
```{r chart, fig.asp=0.7, fig.alt="EUR/GBP Exchange Rate (2010-2020)"}
ggplot(time_series, aes(x = Date, y = EUR_GBP_XR)) +
geom_line(colour = bde_tidy_palettes(n = 1)) +
geom_smooth(method = "gam", colour = bde_tidy_palettes(n = 2)[2]) +
labs(
title = "EUR/GBP Exchange Rate (2010-2020)",
subtitle = "%",
caption = "Source: BdE"
) +
geom_vline(
xintercept = as.Date("2016-06-23"),
linetype = "dotted"
) +
geom_label(aes(
x = as.Date("2016-06-23"),
y = .95,
label = "Brexit"
)) +
coord_cartesian(ylim = c(0.7, 1)) +
theme_tidybde()
```
The package provides also several "shortcut" functions for a selection of the
most relevant macroeconomic series, so there is no need to look for them in
advance:
```{r macroseries, fig.asp=0.7, fig.alt="Spanish Economic Indicators (2010-2019)"}
# Data in "long" format
plotseries <- bde_ind_gdp_var("GDP YoY", out_format = "long") %>%
bind_rows(
bde_ind_unemployment_rate("Unemployment Rate", out_format = "long")
) %>%
drop_na() %>%
filter(Date >= "2010-01-01" & Date <= "2019-12-31")
ggplot(plotseries, aes(x = Date, y = serie_value)) +
geom_line(aes(color = serie_name), linewidth = 1) +
labs(
title = "Spanish Economic Indicators (2010-2019)",
subtitle = "%",
caption = "Source: BdE"
) +
theme_tidybde() +
scale_color_bde_d(palette = "bde_vivid_pal") # Custom palette on the package
```
### Palettes
Two custom palettes, based on the used by BdE on some publications are
available.
Those palettes can be applied to a `ggplot2` using some custom utils included on
the package (see `help("scale_color_bde_d", package = "tidyBdE")`).
### A note on caching
You can use **tidyBdE** to create your own local repository at a given local
directory passing the following option:
``` r
options(bde_cache_dir = "./path/to/location")
```
When this option is set, **tidyBdE** would look for the cached file on the
`bde_cache_dir` directory and it will load it, speeding up the process.
It is possible to update the data (i.e. after every monthly or quarterly data
release) with the following commands:
```{r, eval = FALSE}
bde_catalog_update()
# On most of the functions using the option update_cache = TRUE
bde_series_load("SOME ID", update_cache = TRUE)
```
## Disclaimer
This package is in no way sponsored endorsed or administered by Banco de España.
## Citation
```{r echo=FALSE, results='asis'}
print(citation("tidyBdE"), style = "html")
```
A BibTeX entry for LaTeX users is
```{r echo=FALSE, comment=""}
toBibtex(citation("tidyBdE"))
```