ConstructPash: Pace-Shape Object Constructor

In jschoeley/pash: Pace-Shape Analysis of Life-tables

Description

Construct a pace-shape object.

Usage

ConstructPash(x, nx, nmx, nax, nqx, npx, lx, ndx, nLx, Tx, ex, last_open,
  nax_mode, time_unit, type, input)

Arguments

x	Start of age interval.
nx	Width of age interval [x, x+nx). Must align with x. No zero width allowed.
nmx	Mortality rate in age interval [x, x+nx) measured in deaths per unit of subject-time.
nax	Subject-time spent in age interval [x, x+nx) when dying in that interval.
nqx	Probability to die within age interval [x, x+nx) given survival to x. Must be in range [0, 1].
npx	Probability to survive age interval [x, x+nx) given survival to x. A numeric vector. Must be in range [0, 1].
lx	Life-table survivors at age x. Radix must be 1. Must be in range [0, 1].
ndx	Deaths by life table population in age interval [x, x+nx).
nLx	Total subject-time lived by life-table population in age interval [x, x+nx).
Tx	Total subject-time yet to live past age x by life-table population.
ex	Life expectancy at age x.
last_open	Is the last age group open? Boolean scalar.
nax_mode	The nax specification provided by the user. String scalar.
time_unit	The unit of the ages. String scalar.
type	The type of input used to create the pace-shape object. String scalar.
input	The raw input arguments of the Input[*] function. A list.

Details

Unless otherwise noted in the argument description the input arguments must be non-negative numeric vectors of length > 1 and length == length(x). NA, NaN, Inf, -Inf are not allowed.

Argument type must be one of c("lx", "nmx"). Argument nax_mode must be one of c("udd", "cfm", "vector", "scalar").

Value

An S3 object of class pash.

Warning

Only use when writing new Input functions. For pace-shape object construction use the existing Input functions.

jschoeley/pash documentation built on May 20, 2019, 2:07 a.m.