R/RotationLength.R

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

#' @title RotationLength
#' @description reads rotation length out of a MAgPIE gdx file
#' 
#' @export
#'
#' @param gdx GDX file
#' @param file a file name the output should be written to using write.magpie
#' @param level Level of regional aggregation; "cell", "reg" (regional), "glo" (global), "regglo" (regional and global) or any secdforest aggregation level defined in superAggregate
#' @details Forest rotation length
#' @return Forest rotation length
#' @author Abhijeet Mishra
#' @importFrom gdx readGDX out
#' @importFrom magclass clean_magpie dimSums collapseNames setYears write.magpie
#' @importFrom luscale superAggregate
#' @examples
#' 
#'   \dontrun{
#'     x <- RotationLength(gdx)
#'   }

RotationLength <- function(gdx, file=NULL, level="regglo"){
  a <- NULL
  
  if (level != "regglo"){
    cat("NULL. Set level to regglo.")
  } else{
    harvest_rl   <- readGDX(gdx,"p32_rotation_cellular_harvesting")[,readGDX(gdx,"t"),] * 5
    estb_rl <- readGDX(gdx,"p32_rotation_cellular_estb")[,readGDX(gdx,"t"),] * 5
    a <- mbind(setNames(estb_rl,"Establishment"),setNames(harvest_rl,"Harvest"))

    a <- superAggregate(data = a,aggr_type = "mean",level = "regglo")
    a <- round(a,0)
  }

  out(a,file)
}