R/query_bndespar_portfolio.R

In bndesr: Access Data from the Brazilian Development Bank (BNDES)

#' Queries BNDESPar portfolio data
#'
#' Downloads data from the portfolio since 2006 and return it in the form of a dataframe.
#'
#' @importFrom utils download.file unzip
#'
#' @param year selects the years which data will be downloaded. integer.
#'
#' @return a dataframe with the data
#'
#' @examples
#' df <- query_bndespar_portfolio()
#'
#' @export
query_bndespar_portfolio <- function(year = 'all') {

  ano <- total_percent <- on_percent <- pn_percent <- NULL

  link <- "https://www.bndes.gov.br/arquivos/central-downloads/operacoes_renda_variavel/carteira-renda-variavel.csv"

  if (RCurl::url.exists(link == F)) { # network is down = message (not an error anymore)
    message("No internet connection or data source broken.")
    return(NULL)
  } else { # network is up = proceed to download
    message("Please wait for the download to complete.")

    suppressWarnings({

    tryCatch({
      df <- readr::read_csv2(link, show_col_types = FALSE, skip = 4) |>
        janitor::clean_names()

      },
      # em caso de erro, interrompe a função e mostra msg de erro

      error = function(e) {
        message("Error downloading file. Try again later.", e$message)
        stop("Error downloading file.")  }
    )

    })


    if ("all" %in% year) {
      ano_atual <- as.numeric(format(Sys.Date(), "%Y"))
      year <- c(2002:ano_atual)
    }

    # treatment
    df <- df |>
      dplyr::mutate(total_percent = round(readr::parse_number(total_percent, locale = readr::locale(decimal_mark = ",")), 1),
                    on_percent = round(readr::parse_number(on_percent, locale = readr::locale(decimal_mark = ",")), 1),
                    pn_percent = round(readr::parse_number(pn_percent, locale = readr::locale(decimal_mark = ",")), 1)) |>
      dplyr::filter(ano %in% year) |>
      dplyr::arrange(dplyr::desc(ano))

    message("Completed data query.")

    return(df)
  }
}