predictLT: Predict a Life Table from Child or Child/Adult Mortality.

View source: R/predictLT.R

predictLTR Documentation

Predict a Life Table from Child or Child/Adult Mortality.

Description

svdComp5q0 predicts single-year, age-specific probabilities of dying (1qx) using the SVD-Comp mortality model indexed by child/child-adult mortality.

Usage

predictLT(
  sex,
  cm,
  smooth = TRUE,
  outlogit = FALSE,
  out5 = TRUE,
  am = NULL,
  modsv = 2022
)

Arguments

sex

Character: 'female' or 'male'.

cm

Decimal: the input value(s) for 5q0; either a single value or a vector of values.

smooth

Boolean: use either smooth or raw SVD-derived components. Default is TRUE.

outlogit

Boolean: output either logit scale or natural scale 1qx values. Default is FALSE.

out5

Boolean: if returning natural scale values and out5=TRUE, then return in five-year age groups, 5qx. Default is TRUE.

am

Optional decimal: input value(s) for 45q15; either single value or vector of values. If a vector, must have the same number of elements as cm.

modsv

Optional integer: specifies version of calibration models to use; defaults to 2022 but can be set to 2018.

Value

Data frame: predicted 1qx values for ages 0:109. Age 110 assumed to be 1.0 and not returned. Columns labeled with input child mortality values.

Author(s)

Samuel J. Clark, work@samclark.net

References

https://arxiv.org/abs/1612.01408

Examples

predictLT("female",0.05)
predictLT("female",0.05,modsv=2018)
predictLT("male",0.03,am=0.26)
predictLT("male",0.03,TRUE,TRUE,TRUE,0.26)
predictLT("male",c(0.03,0.01))
## Not run: predictLT("male",c(0.03,0.01),am=0.3)

sinafala/svdComp5q0 documentation built on Sept. 25, 2022, 5:10 a.m.