R/reportPopulation.R

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

#' @title reportPopulation
#' @description reports Population
#'
#' @export
#'
#' @param gdx GDX file
#' @param level spatial aggregation: "reg", "glo", "regglo", "iso"
#' @return population as MAgPIE object
#' @author Florian Humpenoeder
#' @examples
#'
#'   \dontrun{
#'     x <- reportPopulation(gdx)
#'   }
#'

reportPopulation <- function(gdx,level = "regglo") {

  #read in data
  a <- population(gdx,level = level)
  #rename
  getNames(a) <- "Population (million people)"

  return(a)
}