R/gitrd_export_ITR_Data.R

In GetITRData: Reading Financial Reports from Bovespa's ITR System

#' Export tibble to an excel file
#'
#' @param data.in Tibble with financial information (output of gitrd.GetITRData)
#' @param base.file.name The basename of excel file (don't include extension)
#' @param type.export The extension of the desired format (only 'xlsx' implemented so far)
#' @param format.data The format of output. 'wide' (default) for a wide table and 'long' for a long table
#'
#' @return nothing
#' @export
#'
#' @examples
#'
#' # get example data from RData file
#' my.f <- system.file('extdata/ExampleReport_Petrobras.RData', package = 'GetITRData')
#' load(my.f)
#'
#' \dontrun{ # dontrun: keep cran check time short
#' gitrd.export.ITR.data(df.reports, base.file.name = 'MyExcelFile', format.data = 'wide')
#' }
gitrd.export.ITR.data <- function(data.in,
                                  base.file.name = paste0('GetITRData_Export_',Sys.Date()),
                                  type.export = 'xlsx',
                                  format.data = 'wide') {

  # check args
  possible.exports <- c('xlsx')
  if (any(!(type.export %in% type.export))) {
    stop('input type.export should be "xlsx"')
  }

  possible.formats <- c('wide', 'long')
  if (any(!(type.export %in% type.export))) {
    stop('input format.data should be "wide" or "long"')
  }

  f.out <- paste0(base.file.name,'.', type.export)

  if (file.exists(f.out)) {
    cat('File ', f.out, ' already exists. Deleting it..')
    file.remove(f.out)
  }

  # copy metadata
  df.to.copy <- data.in[ ,c("company.name", "company.code", "type.info",
                            "min.date", "max.date", "n.periods")]
  xlsx::write.xlsx(x = df.to.copy, file = f.out,
                   sheetName = 'METADATA',
                   append = T )

  for (i.company in data.in$company.name) {
    cat('\nCopying', format.data, 'data for', i.company)

    temp.df <- data.in[data.in$company.name == i.company, ]

    if (nrow(temp.df$fr.assets[[1]]) == 0) {
      cat('\n\tFound 0 row dataframe for assets. Skipping it..')
      out.asset = data.frame(col = 'NO DATA')
    } else {
      if (format.data == 'wide') {
        out.asset = gitrd.convert.to.wide(temp.df$fr.assets[[1]])
      } else {
        out.asset = temp.df$fr.assets[[1]]
      }
    }

    if (nrow(temp.df$fr.liabilities[[1]]) == 0) {
      cat('\n\tFound 0 row dataframe for liabilities. Skipping it..')
      out.liability = data.frame(col = 'NO DATA')
    } else {
      if (format.data == 'wide') {
        out.liability = gitrd.convert.to.wide(temp.df$fr.liabilities[[1]])
      } else {
        out.liability = temp.df$fr.liabilities[[1]]
      }
    }

    if (nrow(temp.df$fr.income[[1]]) == 0) {
      cat('\n\tFound 0 row dataframe for income. Skipping it..')
      out.income = data.frame(col = 'NO DATA')
    } else {
      if (format.data == 'wide') {
        out.income = gitrd.convert.to.wide(temp.df$fr.income[[1]])
      } else {
        out.income = temp.df$fr.income[[1]]
      }
    }

    if (nrow(temp.df$fr.cashflow[[1]]) == 0) {
      cat('\n\tFound 0 row dataframe for income. Skipping it..')
      out.cashflow = data.frame(col = 'NO DATA')
    } else {
      if (format.data == 'wide') {
        out.cashflow = gitrd.convert.to.wide(temp.df$fr.cashflow[[1]])
      } else {
        out.cashflow = temp.df$fr.cashflow[[1]]
      }
    }

    if (length(temp.df$dividends.history[[1]]) == 0) {
      cat('\n\tFound NA for dividends history. Skipping it..')
      out.dividends = data.frame(col = 'NO DATA')
    } else {
      out.dividends <- temp.df$dividends.history[[1]]
    }

    if (length(temp.df$history.stock.holders[[1]]) == 0) {
      cat('\n\tFound NA for current stock holders. Skipping it..')
      out.stock.holders = data.frame(col = 'NO DATA')
    } else {
      out.stock.holders <- temp.df$history.stock.holders[[1]]
    }

    # copy financial reports
    xlsx::write.xlsx(x = out.asset, file = f.out,
                     sheetName = paste0('ASSETS ',temp.df$company.code,'-', stringr::str_sub(temp.df$company.name,1,5)),
                     append = T )

    xlsx::write.xlsx(x = out.liability, file = f.out,
                     sheetName = paste0('LIABIL ',temp.df$company.code,'-', stringr::str_sub(temp.df$company.name,1,5)),
                     append = T )

    xlsx::write.xlsx(x = out.income, file = f.out,
                     sheetName = paste0('INCOME ',temp.df$company.code,'-', stringr::str_sub(temp.df$company.name,1,5)),
                     append = T )

    xlsx::write.xlsx(x = out.cashflow, file = f.out,
                     sheetName = paste0('CASHFLOW ',temp.df$company.code,'-', stringr::str_sub(temp.df$company.name,1,5)),
                     append = T )

    xlsx::write.xlsx(x = out.dividends, file = f.out,
                     sheetName = paste0('DIV HISTORY ',temp.df$company.code,'-', stringr::str_sub(temp.df$company.name,1,5)),
                     append = T )

    xlsx::write.xlsx(x = out.stock.holders, file = f.out,
                     sheetName = paste0('STOCKHOLDERS ',temp.df$company.code,'-', stringr::str_sub(temp.df$company.name,1,5)),
                     append = T )

  }

  cat('\nExport sucessful')
}