Get data on monthly market expectations for the Top 5 indicators (Focus/BCB)

Source: R/get_monthly_top5.R

This function provides the extraction of data and statistics related to the expectations of economic indicators, specifically the monthly market expectations of the indicators of the Top 5 Focus ranking, made available by the Central Bank of Brazil's Expectations System through the Olinda API. The data comes from several financial institutions: banks, funds, research houses, etc. Important: arguments are case sensitive.

get_monthly_top5(
  indicator = NULL,
  first_date = Sys.Date() - 2 * 365,
  last_date = Sys.Date(),
  reference_date = NULL,
  calc_type = NULL,
  be_quiet = FALSE,
  use_memoise = TRUE,
  do_parallel = FALSE
)

Arguments

indicator

A single string or a character vector with economic indicators names, see details for possible values. Defaults to NULL.

first_date

A single string or Date in "YYYY-mm-dd" format. Default for 2 years prior to the current date.

last_date

A single string or Date in "YYYY-mm-dd" format. Default is the current date.

reference_date

A single string in "mm/YYYY" format, indicating the reference month and year for which the statistic is expected. Defaults to NULL.

calc_type

A single string, NULL or a character vector indicating the calculation type (term) of the statistics. See details for possible values. Defaults to NULL.

be_quiet

Logical. Should messages or warnings not be displayed? Defaults to FALSE.

use_memoise

Logical. Sets the use of caching system, creating a folder named "cache_bcb" by default. Default to TRUE.

do_parallel

Logical. For using parallel data importation. Defaults to FALSE.

Value

A tibble with data from BCB-Olinda Data Services.

Details

For periods for which there are no statistics, they will be omitted from the query.

Possible values for indicator argument: 'IGP-DI', 'IGP-M', 'IPCA', 'Selic', 'Câmbio'.

Possible values for calc_type argument: 'short', 'medium' or 'long'.

Author

Fernando da Silva <fernando@fortietwo.com>

Examples

df <- get_monthly_top5(
  indicator = "IPCA",
  first_date = Sys.Date() - 30,
  reference_date = format(Sys.Date(), "%m/%Y"),
  use_memoise = FALSE
)
#> 
#> Fetching [IPCA] data from BCB-Olinda... 
#> 
#> Found 54 observations!