brfinance (version 0.8.0)

get_gdp_growth: Get GDP Growth Rate

Description

Downloads quarterly GDP growth data (% change) from BCB/SGS (Brazilian Central Bank). This function retrieves nominal GDP values (SGS series 2010) and calculates the quarter-over-quarter growth rate.

Usage

get_gdp_growth(
  start_date = "2000-01-01",
  end_date = NULL,
  language = "eng",
  labels = TRUE
)

Value

A data.frame with GDP growth rate. Columns depend on the language parameter:

• English (language = "eng"): date (Date), gdp_growth (numeric, %)

• Portuguese (language = "pt"): data_referencia (Date), crescimento_pib (numeric, %)

Arguments

start_date

Start date for the data period. Accepts multiple formats:

• "YYYY" for year only (e.g., "2020" becomes "2020-01-01")

• "YYYY-MM" for year and month (e.g., "2020-06" becomes "2020-06-01")

• "YYYY-MM-DD" for a specific date (e.g., "2020-06-15")

end_date

End date for the data period. Accepts the same formats as start_date:

• "YYYY" (e.g., "2023" becomes "2023-12-31")

• "YYYY-MM" (e.g., "2023-12" becomes the last day of December 2023)

• "YYYY-MM-DD" for a specific date

• NULL defaults to the current date (today)

language

Language for column names in the returned data.frame:

• "eng" (default): Returns columns date and gdp_growth

• "pt": Returns columns data_referencia and crescimento_pib

labels

Logical indicating whether to add variable labels using the labelled package. Labels provide descriptive text for each column when available.

Examples

if (FALSE) { # interactive()
  # Default: data from 2000 to current date (but limited to 2014)
  df <- get_gdp_growth()

  # Specific period (within available range)
  df2 <- get_gdp_growth("2010", "2014")

  # Using year-month format
  df3 <- get_gdp_growth("2012-06", "2013-12")

  # End date only (from earliest available to 2020-12-31)
  df4 <- get_gdp_growth(end_date = "2020-12-01")

  # Portuguese column names and labels
  df5 <- get_gdp_growth(language = "pt")

  # Complete example with all parameters
  df6 <- get_gdp_growth("2011-01-01", "2014-12-31", language = "pt", labels = TRUE)
}