insp.dd: Miscellaneous utility functions for 'demogdata' type...

Description Usage Arguments Details Value Author(s) See Also Examples

Description

This function can extract any subset of the source data, such as the mortality (hazard) rates and population (exposure), by a given vector of ages and calendar years. Similarly, the function can output the observed number of deaths by age and calendar years, based on the source data sets included in the demogdata object.

Usage

1
2
insp.dd(data, what = c("rate", "pop", "deaths"), ages = data$age, 
		years = data$year, series = names(data$rate)[1])

Arguments

data

demogdata mortality data object

what

specifies the required type of data matrix to be extracted

ages

vector of ages to inspect in the data

years

vector of years to inspect in the data

series

target series name (e.g. 'males') or index number (e.g. 1) of the data object to be extracted

Details

A subset of mortality rates and population (exposures) can be directly inspected (i.e. extracted) from the corresponding component data matrices in the source demogdata object by using this function. To inspect the observed number of deaths by age and calendar years the function calls extract.deaths without data corrections.

Value

Returns a subset data matrix of the source data.

Author(s)

Zoltan Butt, Steven Haberman and Han Lin Shang

See Also

extract.deaths, extract.ages, extract.years

Examples

1
2
3
4
5
6
# inspect mortality (hazard) rates:
insp.dd(dd.cmi.pens, 'rate', age=50:80, year=1985:1990)
# inspect exposure (population) values:
insp.dd(dd.cmi.pens, 'pop', age=50:80, year=1985:1990)
# inspect 'estimated' number of deaths
insp.dd(dd.cmi.pens, 'deaths', age=50:80, year=1985:1990)


Search within the ilc package
Search all R packages, documentation and source code

Questions? Problems? Suggestions? or email at ian@mutexlabs.com.

Please suggest features or report bugs with the GitHub issue tracker.

All documentation is copyright its authors; we didn't write any of that.