R/calcBiomeType.R

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

#' @title calcBiomeType
#'
#' @description Returns fraction of spatial unit (cell) belonging to a biome
#' type of each biogeographic realm. The classification is based on data from
#' 'the nature conservancy'
#' (https://geospatial.tnc.org/datasets/b1636d640ede4d6ca8f5e369f2dc368b/about)
#' originally developed by Olson et al. (2001), BioScience.
#'
#' @param cells magpiecell (59199 cells) or lpjcell (67420 cells)
#'
#' @return List with a magpie object
#' @author Patrick v. Jeetze
#' @seealso
#' \code{\link{readTNC2019}}
#'
#' @examples
#' \dontrun{
#' calcOutput("BiomeType", aggregate = FALSE)
#' }
#'
calcBiomeType <- function(cells = "lpjcell") {
  # get processed data from 'the nature conservancy'
  x <- readSource("TNC2019", convert = "onlycorrect")

  if (cells == "magpiecell") {
    x <- toolCoord2Isocell(x)
  } else if (cells != "lpjcell") {
    stop("Please specify cells argument")
  }

  landArea <- calcOutput("LanduseInitialisation",
                         aggregate = FALSE, cellular = TRUE, cells = cells,
                         input_magpie = TRUE, years = "y1995", round = 6)
  landArea <- dimSums(landArea, dim = 3)

  if (length(unique(dimSums(x, dim = 3))) > 2) {
    stop("Sum over all biome types != 1 or 0. Check readTNC2019 for errors.")
  }

  x <- x * landArea

  return(list(x = x,
              weight = NULL,
              unit = "Mha",
              description = "Mha of biome type of each
              biogeographic realm in each spatial unit (cell)",
              isocountries = FALSE))
}