R/reportForestYield.R

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

#' @title reportForestYield
#' @description reports MAgPIE harvested area for timber.
#'
#' @export
#'
#' @param gdx GDX file
#' @return Yield from Forests for timber production
#' @author Abhijeet Mishra
#' @examples
#'
#'   \dontrun{
#'     x <- reportForestYield(gdx)
#'   }
#'

reportForestYield<-function(gdx){
  a <- NULL

  if(suppressWarnings(!is.null(readGDX(gdx,"fcostsALL")))){
    a_harvest <- ForestYield(gdx,level = "regglo")
    if(!is.null(a_harvest)){
      getNames(a_harvest) <- paste0("Timber Yields|Harvest|",getNames(a_harvest))
      getNames(a_harvest) <- paste0(getNames(a_harvest)," (tDM per ha)")
      a <- a_harvest
    }
  } else {message("Disabled (no timber) ", appendLF = FALSE)}

  return(a)
}