Movements: Create a demographic account based on movements.

Description Usage Arguments Value Examples

View source: R/Movements-generator.R

Description

The only compulsory argument is population. All demographic series must have a time dimension. In the case of population, the time dimension must have dimscale "Points"; in all other cases it must have dimscale "Intervals".

Usage

1
2
3
4
5
6
7
8
Movements(
  population,
  births = NULL,
  internal = NULL,
  entries = list(),
  exits = list(),
  net = list()
)

Arguments

population

A Counts object.

births

A Counts object.

internal

If internal uses an origin-destination format, an ordinary Counts object; if it uses a pool or net format, an object created by functions collapseOrigDest, Pool, or Net.

entries

A named list of Counts objects.

exits

A named list of Counts objects.

net

A named list of Counts objects.

Value

An object of class Movements

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
population <- Counts(array(c(10, 15, 13, 16),
                           dim = c(2, 2),
                           dimnames = list(age = c("0-29", "30+"),
                                           time = c(1970, 2000))))
births <- Counts(array(13,
                       dim = c(1, 1),
                       dimnames = list(age = "30+",
                                       time = "1971-2000")))
deaths <- Counts(array(c(0, 9),
                       dim = c(2, 1),
                       dimnames = list(age = c("0-29", "30+"),
                                       time = c("1971-2000"))))
account <- Movements(population = population,
                     births = births,
                     exits = list(deaths = deaths))
account
summary(account)

StatisticsNZ/dembase documentation built on Dec. 25, 2021, 4:49 p.m.