net-pool-generators: Create object of class "Net" and "Pool".

In StatisticsNZ/dembase: Analysing Cross-Classified Data about Populations

Description

Object of class Net and Pool are used to describe net flows, or 'in' and 'out' flows, typically to be supplied to function Movements.

Usage

Net(object, between)

Pool(object, direction, between)

## S4 method for signature 'Counts'
Net(object, between)

## S4 method for signature 'Counts'
Pool(object, direction, between)

Arguments

object	An object of class Counts.
between	Names or indices of dimensions of object
direction	Name or index of dimension of object

Details

The 'between' dimensions object are the dimensions between which flows occur. For instance, with internal migration, the 'between' dimension will be something like region. There can be more than one 'between' dimension, e.g. region and employment status.

The 'direction' dimension, which is used only with Pool identifies 'in' flows and 'out' flows. The dimension must have length 2 and must have categories "in" and "out" or "ins" and "outs" (case insensitive). Pool converts the labels to "In" and "Out".

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