R/InitializeModel.R

In USEPA/useeior: USEEIO R modeling software

#' Initialize model with specifications and fundamental crosswalk table.
#' @param modelname Name of the model from a config file.
#' @param configpaths str vector, paths (including file name) of model configuration file
#' and optional agg/disagg configuration file(s). If NULL, built-in config files are used.
#' @return A list of model specifications and fundamental crosswalk table.
initializeModel <- function(modelname, configpaths = NULL) {
  startLogging()
  logging::loginfo("Begin model initialization...")
  model <- list()
  # Get model specs
  model$specs <- getConfiguration(modelname, "model", configpaths)
  if (is.null(model$specs)) {
    stop(paste("No configuration exists for a model named", modelname))
  } else {
    model$crosswalk <- getModelCrosswalk(model)
  }
  return(model)
}

#' Get model crosswalk based on BaseIOSchema and BaseIOLevel
#' @param model EEIO model with specs assigned
#' @return crosswalk as dataframe
getModelCrosswalk <- function(model) {
  # Get model crosswalk
  crosswalk <- get(paste0("MasterCrosswalk", model$specs$BaseIOSchema),
                   as.environment("package:useeior"))
  crosswalk <- unique(crosswalk[, c(paste0("NAICS_", model$specs$BaseIOSchema, "_Code"),
                                    colnames(crosswalk)[startsWith(colnames(crosswalk), "BEA")])])
  colnames(crosswalk) <- gsub(paste0("_", model$specs$BaseIOSchema, "|_Code"),
                              "", colnames(crosswalk))
  rownames(crosswalk) <- NULL
  # Assign initial model crosswalk based on base schema
  modelschema <- "USEEIO"
  baseschema <- paste0("BEA_", model$specs$BaseIOLevel)
  crosswalk[modelschema] <- crosswalk[baseschema]
  return(crosswalk)
}