R/reportGridCroparea.R

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

#' @title reportGridCroparea
#' @description reports Croparea from gridded (disaggregated) output
#' 
#' @export
#' 
#' @param gdx GDX file
#' @param dir for gridded outputs: magpie output directory which contains a mapping file (rds or spam) disaggregation
#' @param spamfiledirectory deprecated. please use \code{dir} instead
#' 
#' @return area of cropland as MAgPIE object (million ha)
#' @author Jannes Breier
#' @examples
#' 
#'   \dontrun{
#'     x <- reportGridCroparea(gdx)
#'   }
#' 

reportGridCroparea <- function(gdx,dir=".",spamfiledirectory="") {
  
  dir <- getDirectory(dir,spamfiledirectory)
  
  x <- croparea(gdx, level = "grid", products = "kcr",product_aggr = FALSE, water_aggr = FALSE,dir=dir)
  
  getNames(x,dim = 1) <- magpiesets::reportingnames(getNames(x,dim = 1))
  getNames(x,dim = 2) <- magpiesets::reportingnames(getNames(x,dim = 2))
  x <- metadata_comments(x=x,unit="Mha physical area", description="Croparea by plant type and irrigation in physical area",comment="",note="")
  
  return(x)
}