R/calcValidGridLand.R

Defines functions calcValidGridLand

Documented in calcValidGridLand

#' @title calcValidGridLand
#' @description reports the main Land types on 0.5 degree grid
#' 
#' @return List of magpie objects with results on cellular level, weight on cellular level, unit and description.
#' @author Benjamin Leon Bodirsky
#' @seealso
#' \code{\link{fullMADRATTOLPJML}}
#' @examples
#' 
#' \dontrun{ 
#' calcOutput("ValidGridLand")
#' }
#' 
#' @importFrom magpiesets reportingnames
#' @importFrom magclass getComment<-

calcValidGridLand <-function() {
 
  out<-calcOutput("LanduseInitialisation",cellular=TRUE,aggregate=FALSE)
  getNames(out,dim=1)<-reportingnames(getNames(out,dim=1))
 
  getComment(out)<-NULL
  
  return(list(x=out,
              weight=NULL,
              unit="Mha",
              description="Total land area in its primary land cover categories. Other includes non-forest natural vegetation like savannas.",
              isocountries=FALSE)
  ) 
}
pik-piam/mrvalidation documentation built on April 26, 2024, 12:12 a.m.