getPopulation: getPopulation

In emunozh/GREGWT: Implements the GREGWT algorithm in R.

Description

Computes the total population of simulation areas using the constrain variables.

Usage

getPopulation(Tx, breaks, area_id_pos = FALSE, area_id = FALSE,
  pop_benchmark = FALSE, du_benchmark = FALSE, building_benchmark = FALSE,
  pop_total_col = FALSE, verbose = FALSE)

Arguments

Tx	census data
breaks	positions of the variable breaks in the census
area_id_pos	(optional, default=FALSE) position of the area id on the census. If FALSE the function will try to use area_id as area codes, if area_id is also FALSE the function will issue an error.
area_id	(optional, default=FALSE) vector of area codes to be used. If If FALSE the function will try to use area_id to identify the column in the census containing the area codes, if area_id_pos is also FALSE the function will issue an error.
pop_benchmark	(optional, default=FALSE) define the benchmark to be used for the computation of the total population, pass as a vector containing the breaks of the benchmark (e.g. pop_benchmark=c(1,5)). If FALSE the function will compute total population as the mean of the all benchmarks.
pop_total_col	(optional, default=FALSE) col containing the population totals

Value

total_pop population total for each simulation area

Author(s)

M. Esteban Munoz H.

Examples

data("GREGWT.census")
total_pop <- getPopulation(GREGWT.census, c(11,17), area_id_pos=1)

emunozh/GREGWT documentation built on May 16, 2019, 5:11 a.m.