bde_series_load: Load a single BdE time-series
In tidyBdE: Download Data from Bank of Spain

bde_series_load

R Documentation

Load a single BdE time-series

Description

The series alias is a positional code showing the location (column and/or row) of the series in the table. However, although it is unique, it is not a good candidate to be used as the series ID, as it is subject to change. If a series changes position in the table, its alias will also change.

To ensure series can still be identified, even after these changes, they are assigned a sequential number (series_code on this function) which will remain unchanged throughout the series' lifetime.

Note that a single series could be used on different tables, so it can have several aliases. If you need to search by alias it is recommended to use bde_series_full_load().

Usage

bde_series_load(
  series_code,
  series_label = NULL,
  out_format = "wide",
  parse_dates = TRUE,
  parse_numeric = TRUE,
  cache_dir = NULL,
  update_cache = FALSE,
  verbose = FALSE,
  extract_metadata = FALSE
)

Arguments

`series_code`	a numeric (or coercible with `base::as.double()` value or vector with time-series code(s), as defined in the field `⁠Número secuencial⁠` of the corresponding series. See `bde_catalog_load()`.
`series_label`	Optional. Character vector or value. Allows to specify a custom label for the series extracted. It should have the same length than `series_code`.
`out_format`	Defines if the format must be returned as a "long" dataset or a "wide" dataset. Possible values are `"wide"` or `"long"`. See Value for Details and Section Examples.
`parse_dates`	Logical. If `TRUE` the dates would be parsed using `bde_parse_dates()`.
`parse_numeric`	Logical. If `TRUE` the columns would be parsed to double (numeric) values. See Note.
`cache_dir`	A path to a cache directory. The directory can also be set via options with `options(bde_cache_dir = "path/to/dir")`.
`update_cache`	Logical. If `TRUE` the requested file would be updated on the `cache_dir`.
`verbose`	Logical `TRUE` or `FALSE`, display information useful for debugging.
`extract_metadata`	Logical `TRUE/FALSE`. On `TRUE` the output is the metadata of the requested series.

Details

Load a single time-series provided by BdE.

Value

A tibble with a field Date and :

With out_format = "wide" each series is presented in a separate column with the name defined by series_label.
With out_format = "long" the tibble would have two more columns, serie_name with the labels of each series and serie_value with the value of the series.

"wide" format is more suitable for exporting to a .csv file while "long" format is more suitable for producing plots with ggplot2::ggplot(). See also tidyr::pivot_longer() and tidyr::pivot_wider().

Note

This function tries to coerce the columns to numbers. For some series a warning may be displayed if the parser fails. You can override the default behavior with parse_numeric = FALSE

Examples



# Metadata
bde_series_load(573234, verbose = TRUE, extract_metadata = TRUE)

# Data
bde_series_load(573234, extract_metadata = FALSE)

# Vectorized
bde_series_load(c(573234, 573214),
  series_label = c("US/EUR", "GBP/EUR"),
  extract_metadata = TRUE
)

wide <- bde_series_load(c(573234, 573214),
  series_label = c("US/EUR", "GBP/EUR")
)

# Wide format
wide


# Long format
long <- bde_series_load(c(573234, 573214),
  series_label = c("US/EUR", "GBP/EUR"),
  out_format = "long"
)

long


# Use with ggplot
library(ggplot2)


ggplot(long, aes(Date, serie_value)) +
  geom_line(aes(group = serie_name, color = serie_name)) +
  scale_color_bde_d() +
  theme_tidybde()

tidyBdE documentation built on Sept. 11, 2024, 5:14 p.m.