R/rb3-package.R

In rb3: Download and Parse Public Data Released by B3 Exchange

#' @title Read files from Brazilian Financial Market
#'
#' @description
#' Read the many files used in Brazilian Financial Market and
#' convert them into useful formats and data structures.
#'
#' @details
#' ## rb3 options
#'
#' rb3 uses `base::options` to allow user set global options that affect the
#' way the package works and display its alerts.
#'
#' \describe{
#'   \item{rb3.cachedir}{
#'     rb3 cache folder is named `rb3-cache` and it is created inside the
#'     directory returned by `base::tempdir`.
#'     Since it is changed for every new session it is interesting to use the
#'     same directory for cache across sessions.
#'     Once the option `rb3.cachedir` is set the files are always cached in
#'     the same directory.
#'     This is very useful to build a historical data.
#'     Historical time series can be loaded directly from cached files.
#'   }
#'   \item{rb3.clear.cache}{
#'     Some files have invalid content returning NULL data.
#'     Every downloaded file is stored in the cache folder.
#'     If `rb3.clear.cache` is TRUE these invalid files are remove once they
#'     are detected.
#'     It helps with keeping only files with valid content in the cache folder.
#'   }
#'   \item{rb3.silent}{
#'     rb3 default behavior on communicating users what's going on is total
#'     transparency.
#'     So, it displays many alert messages to inform users many of the details.
#'     On the other hand, this behavior can be sometimes annoying.
#'     The option `rb3.silent` can be set to `TRUE` in order to avoid that the
#'     alerts be displayed.
#'   }
#' }
#'
#' @name rb3-package
#' @docType package
#'
#' @importFrom ascii ascii
#' @importFrom proto proto
#' @importFrom base64enc base64encode
#' @importFrom bizdays following preceding load_builtin_calendars
#' @importFrom bizdays add.bizdays bizdayse bizseq getdate
#' @importFrom cli cli_alert_info cli_alert_danger cli_alert_success
#' @importFrom cli cli_alert_warning
#' @importFrom cli cli_progress_along pb_spin pb_current pb_total pb_bar
#' @importFrom cli pb_percent pb_eta_str
#' @importFrom digest digest
#' @importFrom dplyr tibble inner_join mutate select filter left_join as_tibble
#' @importFrom dplyr bind_rows arrange rename group_by summarise
#' @importFrom tidyr pivot_longer
#' @importFrom httr GET POST parse_url status_code headers content config
#' @importFrom jsonlite toJSON fromJSON
#' @importFrom purrr map_dfr map_lgl map_chr map_int map
#' @importFrom readr write_rds read_rds read_csv read_file
#' @importFrom readxl read_excel
#' @importFrom rlang .data
#' @importFrom stringr str_replace_all str_starts str_match str_sub str_split
#' @importFrom stringr str_to_lower str_detect str_pad str_replace str_trim
#' @importFrom stringr str_ends str_replace str_c
#' @importFrom stringr str_glue str_length
#' @importFrom yaml yaml.load_file
#' @importFrom methods is new slot
#' @importFrom utils write.table unzip getFromNamespace hasName read.table
#' @importFrom rvest read_html html_nodes html_text
#' @importFrom rvest html_table html_element read_html
#' @importFrom XML xmlInternalTreeParse getNodeSet xmlValue
NULL