R/toolGetMappingCoord2Country.R

In pik-piam/mstools: Tool functions that can be used by several madrat-dependent or magpie4 output functions

#' @title       toolGetMappingCoord2Country
#' @description loads mapping of cellular coordinate data (67420 halfdegree cells) to country iso codes
#'
#' @param pretty If TRUE, coordinate data is returned as numeric 'lon' and 'lat' columns
#' @param extended If TRUE, additional cells missing in the original 67420 data set will be
#' returned as well.
#'
#' @return data frame of mapping
#'
#' @author Felicitas Beier, Kristine Karstens
#'
#' @importFrom stringr str_split
#'
#' @export

toolGetMappingCoord2Country <- function(pretty = FALSE, extended = FALSE) {
  out <- toolGetMapping("mapCoords2Country.rds", where = "mstools")

  if (!extended) {
    out <- out[1:67420, ]
  }

  if (pretty) {
    tmp <- gsub("p", "\\.", str_split(out$coords, "\\.", simplify = TRUE))
    tmp <- as.data.frame(
      matrix(apply(tmp, 2, as.numeric), dim(tmp)[1], dim(tmp)[2],
             dimnames = list(NULL, c("lon", "lat"))
      ),
      stringsAsFactors = FALSE
    )
    out <- data.frame(out, tmp)
  }

  return(out)
}