R/clusterOutputToTerraVector.R

In pik-piam/magpie4: MAgPIE outputs R package for MAgPIE version 4.x

#' @title Convert cluster output to terra vector
#'
#' @description Enriches land use data on cluster resolution with explicit spatial information by
#' creating a terra polygon for each cluster according to the given clustermap.
#'
#' @param x Landuse data on cluster/cell resolution as a magclass object
#' @param clustermap A dataframe mapping with columns cluster, cell, and country
#' @return A SpatVector with the following columns: c("clusterId", "country", "region", "year", "landtype", "value")
#' @author Pascal Führlich, Patrick v. Jeetze
#' @examples
#' \dontrun{
#' landUse <- magpie4::land("fulldata.gdx", level = "cell")
#' clustermap <- readRDS(Sys.glob("clustermap_*.rds"))
#' clusterPolygons <- magpie4::clusterOutputToTerraVector(landUse, clustermap)
#' terra::writeVector(clusterPolygons, "cluster_resolution.shp")
#' }
#'
#' @export
#' @importFrom magclass as.SpatVector
#'
clusterOutputToTerraVector <- function(x, clustermap) {
  if (!requireNamespace("terra", quietly = TRUE)) {
    stop("terra is required for clusterOutputToTerraVector, please run `install.packages('terra')`")
  }
  stopifnot(identical(names(dimnames(x)), c("j.region", "t", "land")))
  x <- addGeometry(x, clustermap)
  return(magclass::as.SpatVector(x))
}