R/calcValidGS.R

In pik-piam/mrvalidation: madrat data preparation for validation purposes

#' calcValidGS
#' 
#' Returns historical FRA 2020 growing stock in million m3 
#' 
#' @param datasource Currently only  available for the "FAO" source
#' @param indicator type of indicator (relative or absolute)
#' @return List of magpie object with growing stock
#' @author Abhijeet Mishra
#' @import magpiesets 
#' @importFrom magclass getNames
#' @importFrom magpiesets FRAnames
#' 
calcValidGS <- function(datasource="FAO",indicator="relative") {
  
  if(datasource=="FAO"){
    a <- collapseNames(readSource("FRA2020",subtype = "growing_stock",convert = TRUE)) 
    indicatorname="Resources|Growing Stock|"
    
    if(indicator=="absolute"){
      absolute <- a[,,grep(pattern = "gs_tot",x = getNames(a),value = TRUE)]
      indicatorname = paste0(indicatorname,indicator,"|+|")
      out <- absolute
      getNames(out) <- gsub(pattern = "gs_tot_",replacement = "",x = getNames(out))
      getNames(out) <- FRAnames(getNames(out))
      unit="Mm3"
      weight = NULL
    } else if(indicator=="relative"){
      relative <- a[,,grep(pattern = "gs_ha",x = getNames(a),value = TRUE)]
      indicatorname = paste0(indicatorname,indicator,"|+|")
      out <- relative
      getNames(out) <- gsub(pattern = "gs_ha_",replacement = "",x = getNames(out))
      getNames(out) <- FRAnames(getNames(out))
      unit="m3/ha"
      weight = collapseNames(readSource("FRA2020",subtype = "forest_area",convert = TRUE))
      getNames(weight) = FRAnames(getNames(weight))
      weight <- weight[,,getNames(out)]
      getNames(weight) <- paste0(indicatorname, getNames(weight)," (",unit,")")
    }

    getNames(out) <- paste0(indicatorname, getNames(out)," (",unit,")")
    
    out <- add_dimension(out, dim=3.1, add="scenario", nm="historical")
    out <- add_dimension(out, dim=3.2, add="model", nm=datasource)
  } else stop("No validation data exists for the given datasource!")
  
  return(list(x=out,
              weight=weight,
              unit=unit,
              description="Growing stock from FAO FRA data")
  )
}