R/reportTimber.R

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

#' @title reportTimber
#' @description reports MAgPIE demand for timber.
#' 
#' @export
#' 
#' @param gdx GDX file
#' @return Timber demand
#' @author Abhijeet Mishra
#' @examples
#' 
#'   \dontrun{
#'     x <- reportTimber(gdx)
#'   }
#' 

reportTimber<-function(gdx){
  a <- NULL
  
  if(suppressWarnings(!is.null(readGDX(gdx,"fcostsALL")))){
    a <- Timber(gdx,level = "regglo")
    getNames(a,dim=2) <- reportingnames(getNames(a,dim=2))
    a <- mbind(a,setNames(dimSums(a,dim = 3.2),paste0(getNames(dimSums(a,dim = 3.2)),".Roundwood")))

    dem <- collapseNames(a[,,"Demand"])
    getNames(dem) <- paste0("Timber|Volumetric|Demand|",getNames(dem))
    getNames(dem) <- paste0(getNames(dem)," (Mm3/yr)")
    
    prod <- collapseNames(a[,,"Production"])
    getNames(prod) <- paste0("Timber|Volumetric|Production|",getNames(prod))
    getNames(prod) <- paste0(getNames(prod)," (Mm3/yr)")
    
    heaven <- collapseNames(a[,,"Heaven"])
    getNames(heaven) <- paste0("Timber|Volumetric|Infeasible|",getNames(heaven))
    getNames(heaven) <- paste0(getNames(heaven)," (Mm3/yr)")
    
    out <- mbind(dem, prod, heaven)
  } else {message("Disabled (no timber) ", appendLF = FALSE)}
  
  return(out)
}