get_annual: Get data on annual market expectations for economic...

In meedr: Macroeconomic Expectations Data in R using the Central Bank of Brazil API

Description

This function provides the extraction of data and statistics related to the expectations of economic indicators, specifically the annual market expectations, 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.

Usage

get_annual(
  indicator = NULL,
  detail = NULL,
  first_date = Sys.Date() - 2 * 365,
  last_date = Sys.Date(),
  reference_date = 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.
detail	A single string. 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 "YYYY" format, indicating the reference year for which the statistic is expected. 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.

Details

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

Possible values for indicator argument: "Balança Comercial", "Balanço de Pagamentos", "Fiscal", "IGP-DI", "IGP-M", "INPC", "IPA-DI", "IPA-M", "IPCA", "IPCA-15", "IPC-FIPE", "Preços administrados por contrato e monitorados", "Produção industrial", "PIB Agropecuária", "PIB Industrial", "PIB Serviços", "PIB Total", "Meta para taxa over-selic", "Taxa de câmbio".

Possible values for detail argument: if indicator "Balança Comercial" -> "Exportações", "Importações", "Saldo"; if indicator "Balanço de Pagamentos" -> "Conta corrente", "Investimento direto no país"; if indicator "Fiscal" -> "Resultado Primário", "Resultado Nominal", "Dívida líquida do setor público"; if indicator "Meta para taxa over-selic" -> "Fim do ano", "Média do ano".

Value

A tibble with data from BCB-Olinda Data Services.

Author(s)

Fernando da Silva <[e-mail]>

Examples

df <- get_annual(
  indicator = "IPCA",
  first_date = Sys.Date() - 30,
  reference_date = format(Sys.Date(), "%Y"),
  use_memoise = FALSE
)

meedr documentation built on July 21, 2021, 5:08 p.m.