get_bank_stats: Retrieves bank-level statistics.

In dkgaraujo/brazilianbanks: Data on Brazilian banks and other regulated financial institutions

Retrieves bank-level statistics.

Description

Retrieves bank-level statistics.

Usage

get_bank_stats(
  yyyymm_start,
  yyyymm_end,
  banks_only = TRUE,
  include_growthrate = TRUE,
  cache_json = TRUE,
  verbose = TRUE
)

Arguments

yyyymm_start	Start calendar quarter for the time series. Accepted formats are: a six-digit integer representing YYYYMM, or a 'Date' class string. Use 'NULL' for all available dates. For a list of available series, please use 'list_dates'.
yyyymm_end	End calendar quarter for the time series. Accepted formats are: a six-digit integer representing YYYYMM, or a 'Date' class string. Use 'NULL' for all available dates. For a list of available series, please use 'list_dates'.
banks_only	TRUE. Whether only the observations related to banks should be kept.
include_growthrate	TRUE. Whether the quarter-on-quarter growth rate for the numeric variables should be calculated.
cache_json	TRUE. Whether the JSON files with the raw data should be cached locally.
verbose	Whether the function must inform the user as it progresses.

Value

A 'tibble' with the bank-level time series in a tidy format.

Examples

## Not run: 
get_bank_stats(yyyymm_start = 202003, yyyymm_end = 202106, sources = "IF.data", verbose = FALSE)

## End(Not run)

dkgaraujo/brazilianbanks documentation built on Jan. 12, 2025, 3:47 p.m.