R/comtrade.R

In ijlyttle/ieeecomtrade: Import IEEE COMTRADE files

#' comtrade constructor
#'
#' @param config list, configuration generated using [`ct_read_config()`]
#' @param data   data frame, data generated using [`ct_read_data()`]
#' @param header character, header (not yet allocated)
#' @param info   character, information (not yet alllocated)
#'
#' @return comtrade object
#' @examples
#'   config <- ct_example("keating_1999.CFG") %>% ct_read_config()
#'   data <- ct_example("keating_1999.DAT") %>% ct_read_data_config(config)
#'   comtrade(config = config, data = data)
#' @export
#'
comtrade <- function(config, data, header = NULL, info = NULL) {

  # TODO: validate inputs

  structure(
    list(
      config = config,
      data = data,
      header = header,
      info = info
    ),
    class = "comtrade"
  )

}