R/calcDevelopmentState.R

In pik-piam/mrcommons: MadRat commons Input Data Library

#' @title calc
#' @description Provides development state of a country or region.
#' We use worldbank definitions by default: above 12746 USD per capita, its a
#' high-income country, below 1045 its a low-income country, in between its a
#' medium-income country.
#'
#' @param upper Change upper limit (default: 12746, i.e. the upper threshold for 2013 in current US$)
#' @param lower Change lower limit (default: 1045, i.e. the lower threshold for 2013 in current US$)
#' @return List of magpie objects with results on country level, weight on country level, unit and description.
#' @author Benjamin Leon Bodirsky, Kristine Karstens
#' @seealso
#' [calcGDPpc()]
#' @examples
#' \dontrun{
#' calcOutput("DevelopmentState")
#' }
#'
calcDevelopmentState <- function(upper = 12746, lower = 1045) {

  gdpPc <- calcOutput("GDPpc", naming = "scenario", aggregate = FALSE, supplementary = TRUE)
  weight <- collapseNames(gdpPc$weight)
  gdpPc <- collapseNames(gdpPc$x)

  developed <- (gdpPc - lower) / (upper - lower)
  developed[developed < 0] <- 0
  developed[developed > 1] <- 1

  return(list(x = developed,
              weight = weight,
              unit = "share",
              description = paste("Development state according to worldbank",
                                  "definitions: 0 is a low income country with less than 1000 USD",
                                  "per capita per year, 1 is a high-income country with more than",
                                  "10000 USD per capita per year. Intermediate values are interpolated",
                                  "lineraly, and indicate medium income countries. Population weighted."),
              min = 0,
              max = 1)
  )
}