R/reportNitrogenBudgetPasture.R

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

#' @title reportNitrogenBudgetCropland
#' @description Reports the Nitrogen Budgets of Croplands for future MAgPIE projections
#'
#' @importFrom magpiesets reportingnames
#' @export
#'
#' @param gdx GDX file
#' @param include_emissions TRUE also divides the N surplus into different emissions
#' @param grid if TRUE, disaggregate to grid level
#' @param dir for gridded outputs: magpie output directory which contains a mapping file (rds or spam) disaggregation
#' @author Benjamin Leon Bodirsky
#' @seealso
#' \code{\link{NitrogenBudget}}
#'
#' @examples
#'   \dontrun{
#'     x <- reportNitrogenBudgetCropland(gdx)
#'   }
#'

reportNitrogenBudgetPasture<-function(gdx,include_emissions=FALSE, grid=FALSE, dir="."){
  
  if (grid==FALSE){

    budget <- NitrogenBudgetPasture(gdx,level = "regglo",include_emissions = include_emissions)
    #budget[,,"som"] = -budget[,,"som"]

    all <- getNames(budget)
    withdrawaltypes <- c("harvest")
    balancetypes <- c("surplus")
    if(include_emissions){
      emissiontypes = c("n2o_n","nh3_n","no2_n","no3_n")
    } else {
      emissiontypes = NULL
    }
    inputtypes<-setdiff(all,c(withdrawaltypes,balancetypes,emissiontypes))

    tmp<-budget[,,inputtypes]
    getNames(tmp)<-paste0("Resources|Nitrogen|Pasture Budget|Inputs|+|",reportingnames(getNames(tmp)))
    inputs<-mbind(
      setNames(dimSums(tmp,dim=3),"Resources|Nitrogen|Pasture Budget|Inputs"),
      tmp
    )

    tmp<-budget[,,withdrawaltypes]
    getNames(tmp)<-paste0("Resources|Nitrogen|Pasture Budget|Withdrawals|+|",reportingnames(getNames(tmp)))
    withdrawals<-mbind(
      setNames(dimSums(tmp,dim=3),"Resources|Nitrogen|Pasture Budget|Withdrawals"),
      tmp
    )

    tmp<-budget[,,balancetypes]
    getNames(tmp)<-paste0("Resources|Nitrogen|Pasture Budget|Balance|+|",reportingnames(getNames(tmp)))
    balance<-mbind(
      setNames(dimSums(tmp,dim=3),"Resources|Nitrogen|Pasture Budget|Balance"),
      tmp
    )

    if(include_emissions){
      tmp <- budget[,,emissiontypes]
      getNames(tmp) <- paste0("Resources|Nitrogen|Pasture Budget|Balance|Nutrient Surplus|",reportingnames(getNames(tmp)))
      emissions <- tmp
    } else {emissions <- NULL}

    out<-mbind(
      inputs,
      withdrawals,
      balance,
      emissions
    )

    getNames(out)<-paste0(getNames(out)," (Mt Nr/yr)")

  } else if (grid == TRUE){

    out<-NitrogenBudgetPasture(gdx,include_emissions = include_emissions, level="grid",dir=dir)
    getNames(out)<-reportingnames(getNames(out))

  } else {warning("grid has to be boolean")}

  return(out)
}