nIteration: Get the number of iterations in a demographic array.

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

Description

If an object of class DemographicArray has a dimension with dimtype "iteration", return the lenth of that dimension; if not, raise an error.

Usage

nIteration(object)

## S4 method for signature 'DemographicArray'
nIteration(object)

Arguments

object

Object of class DemographicArray.

Value

An integer.

Author(s)

John Bryant [e-mail]

See Also

dimtypes, collapseIterations

Examples

library(demdata)
x <- Counts(array(replicate(n = 5, rnorm(2)),
                  dim = c(2, 5),
                  dimnames = list(sex = c("Female", "Male"),
                      iteration = 1:5)))
nIteration(x)

x <- Counts(VAPopn)
## no dimension with dimtype "iteration"
## Not run: nIteration(x)

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