R/CostsFertilizer.R

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

#' @title CostsFertilizer
#' @description reads costs entering the objective function from 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 ("reg", "glo", "regglo")
#' @param disagg whether costs should be disaggregated into the different crop types
#' @return MAgPIE object containing fertilizer costs [million US$05]
#' @author Debbora Leip
#' @importFrom gdx readGDX out
#' @importFrom magclass dimSums 
#' @importFrom luscale superAggregate
#' @examples
#'
#'   \dontrun{
#'     x <- CostsFertilizer(gdx)
#'   }
#'

CostsFertilizer <- function(gdx, file = NULL, level = "regglo", disagg = TRUE){
  
  nr_fertilizer_costs <- readGDX(gdx,"ov_nr_inorg_fert_costs", react = "silent", format = "first_found", select = list(type = "level"))
  
  # disaggregate into crop types
  if (disagg) {
    nr_withdrawals <- readGDX(gdx, "ov50_nr_withdrawals", format = "first_found", select = list(type = "level"))
    nr_withdrawals_shares <- nr_withdrawals/dimSums(nr_withdrawals, dim = "kcr")
    nr_fertilizer_costs <- nr_fertilizer_costs * nr_withdrawals_shares     
  }
  
  nr_fertilizer_costs <- superAggregate(nr_fertilizer_costs, aggr_type = "sum", level = level)
  
  out(nr_fertilizer_costs, file)
}