dp.inputs.pop.percent: Get the percentage of the national population living in a...

View source: R/extract-dp.R

dp.inputs.pop.percentR Documentation

Get the percentage of the national population living in a subnational region

Description

Get the percentage of the national population living in a subnational region

Usage

dp.inputs.pop.percent(
  dp.raw,
  direction = "wide",
  first.year = NULL,
  final.year = NULL
)

Arguments

dp.raw

DemProj module data in raw format, as returned by read.raw.dp()

direction

Request "wide" (default) or "long" format data.

first.year

First year of the projection. If first.year=NULL, it will be filled in using dp.inputs.first.year()

final.year

Final year of the projection. If final.year=NULL, it will be filled in using dp.inputs.final.year()

Value

population sizes by year.

Details

NOTE: THIS INPUT PERTAINS TO A FEATURE THAT HAS BEEN REMOVED FROM SPECTRUM. Countries preparing subnational projections could specify the subnational population by entering a national population size trend, and the share of the national population living in the subnational region.

Use dp.inputs.pop.country to extract the national population of the country the subnational projection resides in.


rlglaubius/SpectrumUtils documentation built on Dec. 20, 2024, 7:31 a.m.