R/reportFoodExpenditure.R

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

#' @title reportFoodExpenditure
#' @description reports per-capita calories food supply (including household waste)
#'
#' @importFrom magpiesets reporthelper
#' @export
#'
#' @param gdx GDX file
#' @param detail if detail=F, the subcategories of groups are not reported (e.g. "soybean" within "oilcrops")
#' @param level spatial aggregation: "reg", "glo", "regglo", "iso"
#' @return per-capita calories as MAgPIE object (kcal/cap/day)
#' @author Benjamin Leon Bodirsky
#' @examples
#'
#'   \dontrun{
#'     x <- reportFoodExpenditure(gdx)
#'   }
#'

reportFoodExpenditure<-function(gdx,detail=FALSE,level="regglo"){
  out<-FoodExpenditure(gdx,level = level,products="kall",product_aggr = FALSE)
  out<-reporthelper(x=out,level_zero_name = "Household Expenditure|Food|Expenditure",detail = detail,partly = TRUE)
  getNames(out) <- paste(getNames(out),"(USD05/capita)",sep=" ")

  out2<-FoodExpenditureShare(gdx,level=level,products = "kfo",product_aggr = TRUE)
  getNames(out2) <- "Household Expenditure|Food|Food Expenditure Share (USD05/USD05)"

  out<-mbind(out,out2)
  #delete empty categories
  out<-out[,,getNames(out)[which(dimSums(out,dim=c(1,2))!=0)]]
  return(out)
}