R/spatial_header.R

In pik-piam/moinput: Model Operations Input Data Library

#' Tool: spatial_header
#' 
#' Given a regionmapping (mapping between ISO countries and regions) the
#' function calculates a 0.5 degree spatial header for 0.5 degree magclass
#' objects
#' 
#' @param mapping Either a path to a mapping or an already read-in mapping as
#' data.frame.
#' @return A vector with 59199 elements
#' @author Jan Philipp Dietrich
#' @export
#' @seealso \code{\link{regionscode}}
#' @examples
#' 
#' \dontrun{
#' spatial_header("regionmappingMAgPIE.csv")
#' }

spatial_header <- function(mapping) {
  if(is.character(mapping)) {
    map <- read.csv(mapping, sep = ";")
  } else if(is.data.frame(mapping)) {
    map <- mapping
  } else {
    stop("Mapping is provided in an unsupported format. It should be either a character or a data.frame!")
  }
  regionscode <- regionscode(map)
  reg <- as.character(map$RegionCode)
  names(reg) <- as.character(map$CountryCode)
  iso <- toolMappingFile("cell","CountryToCellMapping.csv",readcsv = TRUE)$iso
  spatial_header <- paste(reg[iso], 1:length(iso), 
                          sep = ".")
  return(spatial_header)
}