lt_id_morq_a: wrapper to invoke PAS or UN ax methods given qx or mx

View source: R/nAx.R

lt_id_morq_aR Documentation

wrapper to invoke PAS or UN ax methods given qx or mx

Description

Given either mx or qx, call either the lt_a_un() or lt_a_pas() functions.

Usage

lt_id_morq_a(
  nMx,
  nqx,
  axmethod = "pas",
  Age,
  AgeInt,
  a0rule = "ak",
  IMR = NA,
  Sex = "m",
  region,
  OAG = TRUE,
  mod = TRUE,
  SRB = SRB,
  extrapLaw = "kannisto",
  extrapFrom = max(Age),
  extrapFit = Age[Age >= 60],
  ...
)

Arguments

nMx

numeric. Event exposure mortality rates.

nqx

numeric. Vector of age specific death probabilities in standard abridged age groups.

axmethod

character. Either "pas" or "un"

Age

integer. A vector of ages of the lower integer bound of the age classes.

AgeInt

integer. Vector of age interval widths.

a0rule

character. Either "ak" (default) or "cd".

IMR

numeric. Optional. q0, the death probability in first year of life, in case available separately.

Sex

character. "m", "f" or "b" for male, female, or both.

region

character. "n", "e", "s" or "w" for North, East, South, or West.

OAG

logical. Whether or not the last element of nMx is the open age group Default TRUE.

mod

logical. Whether or not to use Gerland's modification for ages 5-14. Default TRUE.

SRB

numeric. The sex ratio at birth (boys/girls), default 1.05.

extrapLaw

character. If extrapolating, which parametric mortality law should be invoked? Options include "Kannisto", "Kannisto_Makeham", "Makeham","Gompertz", "GGompertz", "Beard", "Beard_Makeham", "Quadratic". Default "Kannisto". See details.

extrapFrom

integer. Age from which to impute extrapolated mortality.

extrapFit

integer vector. Ages to include in model fitting. Defaults to all ages > =60.

...

Other arguments to be passed on to the MortalityLaw function.

Value

nax average contribution to exposure of those dying in the interval.

References

\insertRef

greville1977shortDemoTools \insertRefun1982modelDemoTools \insertRefarriaga1994populationDemoTools \insertRefmortpak1988DemoTools \insertRefunited1983manualDemoTools \insertRefPASDemoTools


timriffe/DemoTools documentation built on Jan. 28, 2024, 5:13 a.m.