R/read_td_file.R

In GetTDData: Get Data for Brazilian Bonds (Tesouro Direto)

#' Reads and cleans data from a Tesouro Direto Excel file
#'
#' @param local_file The path to the local Excel file to read.
#'
#' @return A data frame containing the cleaned data.
#'
#' @noRd
read_td_file <- function(local_file) {

  cli::cli_alert_info('Reading {local_file}')

  # Use capture.output so that no message "DEFINEDNAME" is shown
  # Details in: https://github.com/hadley/readxl/issues/82#issuecomment-166767220

  #utils::capture.output({
  sheets <- readxl::excel_sheets(local_file)
  #})

  df_list <- list()
  for (i_sheet in sheets) {

    cli::cli_alert_success('\tReading Sheet {i_sheet}')

    # Read it with readxl (use capture.output to avoid "DEFINEDNAME:"  issue)
    # see: https://github.com/hadley/readxl/issues/111/
    utils::capture.output({
      temp_df <- readxl::read_excel(path =local_file,
                                    sheet = i_sheet,
                                    skip = 1 )
    })

    # make sure it is a dataframe (readxl has a different format as output)
    temp_df <- temp_df |>
      as.data.frame() |>
      clean_td_data()

    temp_df$asset_code <- i_sheet

    # filter columns to import


    df_list[[i_sheet]] <- temp_df
  }

  this_df <- dplyr::bind_rows(df_list)
  return(this_df)

}