R/calcLandArea.R

In pik-piam/mrcommons: MadRat commons Input Data Library

#' @title calcLandArea
#' @description total land area in a cell
#' @param cells "magpiecell" for 59199 cells or "lpjcell" for 67420 cells
#' @return magpie object in cellular resolution
#' @author Jan Philipp Dietrich, Felicitas Beier
#'
#' @examples
#' \dontrun{
#' calcOutput("LandArea", aggregate = FALSE)
#' }
#'
calcLandArea <- function(cells = "lpjcell") {

  x <- calcOutput("LanduseInitialisation", input_magpie = TRUE,
                   aggregate = FALSE, cellular = TRUE, cells = cells,
                   years = "y1995", round = 6)

  x <- setYears(dimSums(x, dim = 3), NULL)

  return(list(x = x,
              weight = NULL,
              unit = "mio. ha",
              description = "total land area in a cell",
              isocountries = FALSE))
}