ageTimeStep: Get the age-time step used by a demographic array.

Description Usage Arguments Value See Also Examples

Description

If a object has a regular age-time plan, then ageTimeStep returns the length of the age-time steps used; otherwise it raises an error.

Usage

1
2
3
4
5
6
7
ageTimeStep(object)

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

## S4 method for signature 'MetaData'
ageTimeStep(object)

Arguments

object

Object of class DemographicArray.

Value

A number (i.e. a numeric vector of length 1).

See Also

hasRegularAgeTime, DemographicArray, dimtypes, dimscales

Examples

1
2
3
4
library(demdata)
x <- Counts(VAPopn)
x
hasRegularAgeTime(x)

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