From 27cc366e1e43058107f0d2911afa51265e516fb3 Mon Sep 17 00:00:00 2001 From: timriffe Date: Tue, 8 Oct 2024 19:30:11 +0200 Subject: [PATCH] no more notes coming from documentation --- R/lt_abridged.R | 26 +++++++++---------- R/lt_regroup_age.R | 53 +++++++++++++++++++-------------------- R/lt_single.R | 26 +++++++++---------- R/lt_single_qx.R | 25 +++++++++--------- R/mig_rc.R | 11 ++++---- R/nAx.R | 14 +++++------ R/utilsAge.R | 16 ++++++------ man/age2ageN.Rd | 2 +- man/int2ageN.Rd | 2 +- man/lt_abridged.Rd | 22 ++++++++-------- man/lt_abridged2single.Rd | 22 ++++++++-------- man/lt_rule_1a0_cd.Rd | 11 ++++---- man/lt_single2abridged.Rd | 26 +++++++++---------- man/lt_single_mx.Rd | 22 ++++++++-------- man/lt_single_qx.Rd | 22 ++++++++-------- man/mig_calculate_rc.Rd | 9 ++++--- 16 files changed, 153 insertions(+), 156 deletions(-) diff --git a/R/lt_abridged.R b/R/lt_abridged.R index ee3714ba8..484ef7d1f 100644 --- a/R/lt_abridged.R +++ b/R/lt_abridged.R @@ -45,19 +45,19 @@ #' @importFrom dplyr case_when #' @export #' @return Lifetable in data.frame with columns -#' \itemize{ -#' \item{Age}{integer. Lower bound of abridged age class}, -#' \item{AgeInt}{integer. Age class widths.} -#' \item{nMx}{numeric. Age-specific central death rates.} -#' \item{nAx}{numeric. Average time spent in interval by those deceased in interval. } -#' \item{nqx}{numeric. Age-specific conditional death probabilities.} -#' \item{lx}{numeric. Lifetable survivorship} -#' \item{ndx}{numeric. Lifetable deaths distribution.} -#' \item{nLx}{numeric. Lifetable exposure.} -#' \item{Sx}{numeric. Survivor ratios in uniform 5-year age groups.} -#' \item{Tx}{numeric. Lifetable total years left to live above age x.} -#' \item{ex}{numeric. Age-specific remaining life expectancy.} -#' } + +#' * Age integer. Lower bound of abridged age class +#' * AgeInt integer. Age class widths. +#' * nMx numeric. Age-specific central death rates. +#' * nAx numeric. Average time spent in interval by those deceased in interval. +#' * nqx numeric. Age-specific conditional death probabilities. +#' * lx numeric. Lifetable survivorship +#' * ndx numeric. Lifetable deaths distribution. +#' * nLx numeric. Lifetable exposure. +#' * Sx numeric. Survivor ratios in uniform 5-year age groups. +#' * Tx numeric. Lifetable total years left to live above age x. +#' * ex numeric. Age-specific remaining life expectancy. +#' #' @references #' \insertRef{greville1977short}{DemoTools} #' \insertRef{un1982model}{DemoTools} diff --git a/R/lt_regroup_age.R b/R/lt_regroup_age.R index b2e557011..10653ea3e 100644 --- a/R/lt_regroup_age.R +++ b/R/lt_regroup_age.R @@ -11,20 +11,19 @@ #' @param nLx numeric. Vector of lifetable exposure at single ages. #' @param ex numeric. Vector of Age-specific remaining life expectancy at single ages. #' @param ... optional args, not currently used. -#' @return Abridged lifetable in data.frame with columns -#' \itemize{ -#' \item{Age}{integer. Lower bound of abridged age class}, -#' \item{AgeInt}{integer. Age class widths.} -#' \item{nMx}{numeric. Age-specific central death rates.} -#' \item{nAx}{numeric. Average time spent in interval by those deceased in interval. } -#' \item{nqx}{numeric. Age-specific conditional death probabilities.} -#' \item{lx}{numeric. Lifetable survivorship} -#' \item{ndx}{numeric. Lifetable deaths distribution.} -#' \item{nLx}{numeric. Lifetable exposure.} -#' \item{Sx}{numeric. Survivor ratios in uniform 5-year age groups.} -#' \item{Tx}{numeric. Lifetable total years left to live above age x.} -#' \item{ex}{numeric. Age-specific remaining life expectancy.} -#' } +#' @return Abridged lifetable in `data.frame` with columns +#' `Age` integer. Lower bound of abridged age class +#' `AgeInt` integer. Age class widths. +#' `nMx` numeric. Age-specific central death rates. +#' `nAx` numeric. Average time spent in interval by those deceased in interval. +#' `nqx` numeric. Age-specific conditional death probabilities. +#' `lx` numeric. Lifetable survivorship +#' `ndx` numeric. Lifetable deaths distribution. +#' `nLx` numeric. Lifetable exposure. +#' `Sx` numeric. Survivor ratios in uniform 5-year age groups. +#' `Tx` numeric. Lifetable total years left to live above age x. +#' `ex` numeric. Age-specific remaining life expectancy. +#' #' #' @export #' @@ -83,19 +82,19 @@ lt_single2abridged <- function(lx, #' @inheritParams lt_abridged #' @param ... optional arguments passed to `pclm()`. For example, if you pass an explicit `lambda` parameter via the `control` argument, you can speed up estimation #' @return Single-year lifetable in data.frame with columns -#' \itemize{ -#' \item{Age}{integer. Lower bound of single year age class}, -#' \item{AgeInt}{integer. Age class widths.} -#' \item{nMx}{numeric. Age-specific central death rates.} -#' \item{nAx}{numeric. Average time spent in interval by those deceased in interval. } -#' \item{nqx}{numeric. Age-specific conditional death probabilities.} -#' \item{lx}{numeric. Lifetable survivorship} -#' \item{ndx}{numeric. Lifetable deaths distribution.} -#' \item{nLx}{numeric. Lifetable exposure.} -#' \item{Sx}{numeric. Survivor ratios.} -#' \item{Tx}{numeric. Lifetable total years left to live above age x.} -#' \item{ex}{numeric. Age-specific remaining life expectancy.} -#' } + +#' * `Age` integer. Lower bound of single year age class +#' * `AgeInt` integer. Age class widths. +#' * `nMx` numeric. Age-specific central death rates. +#' * `nAx` numeric. Average time spent in interval by those deceased in interval. +#' * `nqx` numeric. Age-specific conditional death probabilities. +#' * `lx` numeric. Lifetable survivorship +#' * `ndx` numeric. Lifetable deaths distribution. +#' * `nLx` numeric. Lifetable exposure. +#' * `Sx` numeric. Survivor ratios. +#' * `Tx` numeric. Lifetable total years left to live above age x. +#' * `ex` numeric. Age-specific remaining life expectancy. + #' #' @export #' @importFrom ungroup pclm diff --git a/R/lt_single.R b/R/lt_single.R index 60cbaac5a..2429b6145 100644 --- a/R/lt_single.R +++ b/R/lt_single.R @@ -5,19 +5,19 @@ #' @details Similar to \code{lt_abridged()} details, forthcoming #' @inheritParams lt_abridged #' @return Lifetable in data.frame with columns -#' \itemize{ -#' \item{Age}{integer. Lower bound of abridged age class}, -#' \item{AgeInt}{integer. Age class widths.} -#' \item{nMx}{numeric. Age-specific central death rates.} -#' \item{nAx}{numeric. Average time spent in interval by those deceased in interval. } -#' \item{nqx}{numeric. Age-specific conditional death probabilities.} -#' \item{lx}{numeric. Lifetable survivorship} -#' \item{ndx}{numeric. Lifetable deaths distribution.} -#' \item{nLx}{numeric. Lifetable exposure.} -#' \item{Sx}{numeric. Survivor ratios in uniform 5-year age groups.} -#' \item{Tx}{numeric. Lifetable total years left to live above age x.} -#' \item{ex}{numeric. Age-specific remaining life expectancy.} -#' } + +#' * `Age` integer. Lower bound of abridged age class +#' * `AgeInt` integer. Age class widths. +#' * `nMx` numeric. Age-specific central death rates. +#' * `nAx` numeric. Average time spent in interval by those deceased in interval. +#' * `nqx` numeric. Age-specific conditional death probabilities. +#' * `lx` numeric. Lifetable survivorship +#' * `ndx` numeric. Lifetable deaths distribution. +#' * `nLx` numeric. Lifetable exposure. +#' * `Sx` numeric. Survivor ratios in uniform 5-year age groups. +#' * `Tx` numeric. Lifetable total years left to live above age x. +#' * `ex` numeric. Age-specific remaining life expectancy. +#' #' @export #' @importFrom dplyr case_when lt_single_mx <- function(nMx, diff --git a/R/lt_single_qx.R b/R/lt_single_qx.R index 988fd4886..df3e8ad23 100644 --- a/R/lt_single_qx.R +++ b/R/lt_single_qx.R @@ -6,19 +6,18 @@ #' @details Similar to \code{lt_abridged()} details, forthcoming #' @inheritParams lt_abridged #' @return Lifetable in data.frame with columns -#' \itemize{ -#' \item{Age}{integer. Lower bound of abridged age class}, -#' \item{AgeInt}{integer. Age class widths.} -#' \item{nMx}{numeric. Age-specific central death rates.} -#' \item{nAx}{numeric. Average time spent in interval by those deceased in interval. } -#' \item{nqx}{numeric. Age-specific conditional death probabilities.} -#' \item{lx}{numeric. Lifetable survivorship} -#' \item{ndx}{numeric. Lifetable deaths distribution.} -#' \item{nLx}{numeric. Lifetable exposure.} -#' \item{Sx}{numeric. Survivor ratios in uniform single-year age groups.} -#' \item{Tx}{numeric. Lifetable total years left to live above age x.} -#' \item{ex}{numeric. Age-specific remaining life expectancy.} -#' } +#' * `Age` integer. Lower bound of abridged age class, +#' * `AgeInt` integer. Age class widths. +#' * `nMx` numeric. Age-specific central death rates. +#' * `nAx` numeric. Average time spent in interval by those deceased in interval. +#' * `nqx` numeric. Age-specific conditional death probabilities. +#' * `lx` numeric. Lifetable survivorship +#' * `ndx` numeric. Lifetable deaths distribution. +#' * `nLx` numeric. Lifetable exposure. +#' * `Sx` numeric. Survivor ratios in uniform single-year age groups. +#' * `Tx` numeric. Lifetable total years left to live above age x. +#' * `ex` numeric. Age-specific remaining life expectancy. + #' @importFrom utils head #' @export lt_single_qx <- function(nqx, diff --git a/R/mig_rc.R b/R/mig_rc.R index 28ee1c223..95df9bf34 100644 --- a/R/mig_rc.R +++ b/R/mig_rc.R @@ -18,12 +18,11 @@ #' #' The first, second, third and fourth pieces of the equation represent pre-working age, working age, retirement and post-retirement age patterns, respectively. #' Models with less parameters gradually remove terms at the older ages. Parameters in each family are: -#' \itemize{ -#' \item pre-working age: {a1, alpha1} -#' \item working age: {a2, alpha2, mu2, lambda2} -#' \item retirement: {a3, alpha3, mu3, lambda3} -#' \item post retirement: {a4, lambda4} -#' } +#' * pre-working age: a1, alpha1 +#' * working age: a2, alpha2, mu2, lambda2 +#' * retirement: a3, alpha3, mu3, lambda3 +#' * post retirement: a4, lambda4 +#' #' For a specific family to be included, values for all parameters in that family must be specified. #' #' @references diff --git a/R/nAx.R b/R/nAx.R index 729fcd1d2..d04ff844b 100644 --- a/R/nAx.R +++ b/R/nAx.R @@ -17,13 +17,13 @@ #' @param region character. \code{"n"}, \code{"e"}, \code{"s"} or \code{"w"} for North, East, South, or West. #' #' @details If \code{IMR} is not given, then \code{M0} is converted to q(0) using the following approximation: -#' \enumerate{ -#' \item{Find \eqn{\alpha , \beta}.}{ Look up the appropriate slope and intercept for the given sex and region.} -#' \item{calculate \eqn{a} as: }{\ifelse{html}{\out{a = M0 * β}}{\eqn{a = M_0 * \beta}}} -#' \item{calculate \eqn{b} as: }{\ifelse{html}{\out{b = 1 + M0 *(1- α)}}{\eqn{b = 1 + M_0 * (1 - \alpha)}}} -#' \item{approximate {\ifelse{html}{\out{q0}}{\eqn{q_0}}} as:}{ \ifelse{html}{\out{q0 = (b2- √ [b -4*a*M0]) / (2*a)}}{\eqn{q_0 = \frac{ b - sqrt(b^2 - 4 * a * M_0) }{ 2 * a } }}} -#' \item{use {\ifelse{html}{\out{q0}}{\eqn{q_0}}} as}{ IMR, and applied directly to the Coale-Demeny piecewise linear formula.} -#' } + +#' 1. Find \eqn{\alpha , \beta}. Look up the appropriate slope and intercept for the given sex and region. +#' 2. calculate \eqn{a} as: \ifelse{html}{\out{a = M0 * β}}{\eqn{a = M_0 * \beta}} +#' 3. calculate \eqn{b} as: \ifelse{html}{\out{b = 1 + M0 *(1- α)}}{\eqn{b = 1 + M_0 * (1 - \alpha)}} +#' 4. approximate {\ifelse{html}{\out{q0}}{\eqn{q_0}}} as: \ifelse{html}{\out{q0 = (b2- √ [b -4*a*M0]) / (2*a)}}{\eqn{q_0 = \frac{ b - sqrt(b^2 - 4 * a * M_0) }{ 2 * a } }} +#' 5. use {\ifelse{html}{\out{q0}}{\eqn{q_0}}} as IMR, and applied directly to the Coale-Demeny piecewise linear formula. +#' #' If \code{IMR} is given, then \code{M0} is disregarded, and transitivity is therefore not guaranteed. In this case, one has the option to use \code{lt_id_qm_a()} to derive \code{a(0)}, however discrepancies between these two parameters could force implausible results in \code{a(0)}, whereas the CD rule always gives something plausible. #' #' @references diff --git a/R/utilsAge.R b/R/utilsAge.R index 1c6082b01..3ea1720e4 100644 --- a/R/utilsAge.R +++ b/R/utilsAge.R @@ -87,7 +87,7 @@ calcAgeN <- function(Age, N = 5, shiftdown = 0) { #' repeat age lower bounds once for each single age #' @description This is a frequent grouping situation. For a given vector of lower age bounds, repeat each value N times, where N is the width of the corresponding age interval. Age intervals are in this case calculated from the original Age vector. -#' @details If {OAG = TRUE} then the last value is not repeated, otherwise the final age interval is assumed to be the same width as the penultimate. Here intervals do not need to be of uniform width. +#' @details If `OAG = TRUE` then the last value is not repeated, otherwise the final age interval is assumed to be the same width as the penultimate. Here intervals do not need to be of uniform width. #' @param Age integer. Vector of lower age bounds. #' @param AgeInt integer vector of age group widths. #' @param OAG logical. Whether or not the final age group open. Default \code{FALSE}. See details @@ -105,11 +105,11 @@ age2ageN <- function(Age, AgeInt = NULL, OAG = FALSE) { } #' repeat age lower bounds once for each single age -#' @description This is a frequent grouping situation. For a given vector of lower age bounds, as implied by \code{AgeInt}, repeat each value N times, where N is the width of the corresponding age interval. Age intervals are in this case given, and age lower bound values are calculated from \code{AgeInt} vector. -#' @details If {OAG = TRUE} then the last value is given just once, irrespective of the final value of \code{AgeInt}, otherwise the final age interval is repeated \code{AgeInt[length(AgeInt)]} times. Here intervals do not need to be of uniform width. +#' @description This is a frequent grouping situation. For a given vector of lower age bounds, as implied by `AgeInt`, repeat each value N times, where N is the width of the corresponding age interval. Age intervals are in this case given, and age lower bound values are calculated from `AgeInt` vector. +#' @details If `OAG == TRUE` then the last value is given just once, irrespective of the final value of `AgeInt`, otherwise the final age interval is repeated `AgeInt[length(AgeInt)]` times. Here intervals do not need to be of uniform width. #' @param AgeInt integer or numeric. Vector of age intervals. -#' @param OAG logical. Whether or not the final age group open. Default \code{FALSE}. See details -#' @return integer vector of elements of \code{Age} repeated once for each implied single age. +#' @param OAG logical. Whether or not the final age group open. Default `FALSE`. See details +#' @return integer vector of elements of `Age` repeated once for each implied single age. #' @export #' @examples #' int5 <- rep(5,21) @@ -155,7 +155,7 @@ calcAgeAbr <- function(Age) { #' @param Age integer. Vector of lower bound of each age group. #' @param vec Any vector, presumably a count, rate, or similar. #' @param OAG logical. Whether or not the final age group open. Default \code{FALSE}. -#' @param OAvalue numeric or integer. The value to use for the final age interval if \code{OAG = TRUE}. Default \code{NA}. +#' @param OAvalue numeric or integer. The value to use for the final age interval if `OAG = TRUE`. Default `NA`. #' #' @details If based solely on the length of a vector, this will give erroneous results if ages #' are anything other than standard abridged ages groups. If the final age group is open, the @@ -235,10 +235,10 @@ int2age <- function(AgeInt, ageMin = 0) { #' @description Determine age class intervals based on a vector of age class lower bounds. #' @details If the final age group is open, it is given a value of \code{NA} by default, or else a user-determined value. #' If the final age group is closed, it is assumed to be equal to the next-lower interval. If the final age interval is -#' known and not equal to the next lowest interval, specify \code{OAG = TRUE} and assign its value to \code{OAvalue}. +#' known and not equal to the next lowest interval, specify `OAG = TRUE` and assign its value to `OAvalue`. #' @param Age integer or numeric. Vector of lower age group bounds . #' @param OAG logical. Whether or not the final age group is open. Default \code{TRUE}. -#' @param OAvalue numeric or integer. The value to use for the final age interval if \code{OAG = TRUE}. Default \code{NA}. +#' @param OAvalue numeric or integer. The value to use for the final age interval if `OAG = TRUE`. Default `NA`. #' @export #' @return Age interval vector, of same length as \code{Age}. #' @examples diff --git a/man/age2ageN.Rd b/man/age2ageN.Rd index 66af594d2..2d3187560 100644 --- a/man/age2ageN.Rd +++ b/man/age2ageN.Rd @@ -20,7 +20,7 @@ integer vector of elements of \code{Age} repeated once for each implied single a This is a frequent grouping situation. For a given vector of lower age bounds, repeat each value N times, where N is the width of the corresponding age interval. Age intervals are in this case calculated from the original Age vector. } \details{ -If {OAG = TRUE} then the last value is not repeated, otherwise the final age interval is assumed to be the same width as the penultimate. Here intervals do not need to be of uniform width. +If \code{OAG = TRUE} then the last value is not repeated, otherwise the final age interval is assumed to be the same width as the penultimate. Here intervals do not need to be of uniform width. } \examples{ age1 <- seq(0,100,by=5) diff --git a/man/int2ageN.Rd b/man/int2ageN.Rd index f1e7adfe4..5620199b8 100644 --- a/man/int2ageN.Rd +++ b/man/int2ageN.Rd @@ -18,7 +18,7 @@ integer vector of elements of \code{Age} repeated once for each implied single a This is a frequent grouping situation. For a given vector of lower age bounds, as implied by \code{AgeInt}, repeat each value N times, where N is the width of the corresponding age interval. Age intervals are in this case given, and age lower bound values are calculated from \code{AgeInt} vector. } \details{ -If {OAG = TRUE} then the last value is given just once, irrespective of the final value of \code{AgeInt}, otherwise the final age interval is repeated \code{AgeInt[length(AgeInt)]} times. Here intervals do not need to be of uniform width. +If \code{OAG == TRUE} then the last value is given just once, irrespective of the final value of \code{AgeInt}, otherwise the final age interval is repeated \code{AgeInt[length(AgeInt)]} times. Here intervals do not need to be of uniform width. } \examples{ int5 <- rep(5,21) diff --git a/man/lt_abridged.Rd b/man/lt_abridged.Rd index de3ed4cbf..c0b9a2e6f 100644 --- a/man/lt_abridged.Rd +++ b/man/lt_abridged.Rd @@ -76,17 +76,17 @@ lt_abridged( \value{ Lifetable in data.frame with columns \itemize{ -\item{Age}{integer. Lower bound of abridged age class}, -\item{AgeInt}{integer. Age class widths.} -\item{nMx}{numeric. Age-specific central death rates.} -\item{nAx}{numeric. Average time spent in interval by those deceased in interval. } -\item{nqx}{numeric. Age-specific conditional death probabilities.} -\item{lx}{numeric. Lifetable survivorship} -\item{ndx}{numeric. Lifetable deaths distribution.} -\item{nLx}{numeric. Lifetable exposure.} -\item{Sx}{numeric. Survivor ratios in uniform 5-year age groups.} -\item{Tx}{numeric. Lifetable total years left to live above age x.} -\item{ex}{numeric. Age-specific remaining life expectancy.} +\item Age integer. Lower bound of abridged age class +\item AgeInt integer. Age class widths. +\item nMx numeric. Age-specific central death rates. +\item nAx numeric. Average time spent in interval by those deceased in interval. +\item nqx numeric. Age-specific conditional death probabilities. +\item lx numeric. Lifetable survivorship +\item ndx numeric. Lifetable deaths distribution. +\item nLx numeric. Lifetable exposure. +\item Sx numeric. Survivor ratios in uniform 5-year age groups. +\item Tx numeric. Lifetable total years left to live above age x. +\item ex numeric. Age-specific remaining life expectancy. } } \description{ diff --git a/man/lt_abridged2single.Rd b/man/lt_abridged2single.Rd index 0108ad755..34412779b 100644 --- a/man/lt_abridged2single.Rd +++ b/man/lt_abridged2single.Rd @@ -72,17 +72,17 @@ lt_abridged2single( \value{ Single-year lifetable in data.frame with columns \itemize{ -\item{Age}{integer. Lower bound of single year age class}, -\item{AgeInt}{integer. Age class widths.} -\item{nMx}{numeric. Age-specific central death rates.} -\item{nAx}{numeric. Average time spent in interval by those deceased in interval. } -\item{nqx}{numeric. Age-specific conditional death probabilities.} -\item{lx}{numeric. Lifetable survivorship} -\item{ndx}{numeric. Lifetable deaths distribution.} -\item{nLx}{numeric. Lifetable exposure.} -\item{Sx}{numeric. Survivor ratios.} -\item{Tx}{numeric. Lifetable total years left to live above age x.} -\item{ex}{numeric. Age-specific remaining life expectancy.} +\item \code{Age} integer. Lower bound of single year age class +\item \code{AgeInt} integer. Age class widths. +\item \code{nMx} numeric. Age-specific central death rates. +\item \code{nAx} numeric. Average time spent in interval by those deceased in interval. +\item \code{nqx} numeric. Age-specific conditional death probabilities. +\item \code{lx} numeric. Lifetable survivorship +\item \code{ndx} numeric. Lifetable deaths distribution. +\item \code{nLx} numeric. Lifetable exposure. +\item \code{Sx} numeric. Survivor ratios. +\item \code{Tx} numeric. Lifetable total years left to live above age x. +\item \code{ex} numeric. Age-specific remaining life expectancy. } } \description{ diff --git a/man/lt_rule_1a0_cd.Rd b/man/lt_rule_1a0_cd.Rd index 0f3d31237..76ba051c2 100644 --- a/man/lt_rule_1a0_cd.Rd +++ b/man/lt_rule_1a0_cd.Rd @@ -25,12 +25,13 @@ In this and some other older texts, a(0) is known as a 'separation factor'. \details{ If \code{IMR} is not given, then \code{M0} is converted to q(0) using the following approximation: \enumerate{ -\item{Find \eqn{\alpha , \beta}.}{ Look up the appropriate slope and intercept for the given sex and region.} -\item{calculate \eqn{a} as: }{\ifelse{html}{\out{a = M0 * β}}{\eqn{a = M_0 * \beta}}} -\item{calculate \eqn{b} as: }{\ifelse{html}{\out{b = 1 + M0 *(1- α)}}{\eqn{b = 1 + M_0 * (1 - \alpha)}}} -\item{approximate {\ifelse{html}{\out{q0}}{\eqn{q_0}}} as:}{ \ifelse{html}{\out{q0 = (b2- √ [b -4*a*M0]) / (2*a)}}{\eqn{q_0 = \frac{ b - sqrt(b^2 - 4 * a * M_0) }{ 2 * a } }}} -\item{use {\ifelse{html}{\out{q0}}{\eqn{q_0}}} as}{ IMR, and applied directly to the Coale-Demeny piecewise linear formula.} +\item Find \eqn{\alpha , \beta}. Look up the appropriate slope and intercept for the given sex and region. +\item calculate \eqn{a} as: \ifelse{html}{\out{a = M0 * β}}{\eqn{a = M_0 * \beta}} +\item calculate \eqn{b} as: \ifelse{html}{\out{b = 1 + M0 *(1- α)}}{\eqn{b = 1 + M_0 * (1 - \alpha)}} +\item approximate {\ifelse{html}{\out{q0}}{\eqn{q_0}}} as: \ifelse{html}{\out{q0 = (b2- √ [b -4*a*M0]) / (2*a)}}{\eqn{q_0 = \frac{ b - sqrt(b^2 - 4 * a * M_0) }{ 2 * a } }} +\item use {\ifelse{html}{\out{q0}}{\eqn{q_0}}} as IMR, and applied directly to the Coale-Demeny piecewise linear formula. } + If \code{IMR} is given, then \code{M0} is disregarded, and transitivity is therefore not guaranteed. In this case, one has the option to use \code{lt_id_qm_a()} to derive \code{a(0)}, however discrepancies between these two parameters could force implausible results in \code{a(0)}, whereas the CD rule always gives something plausible. } \examples{ diff --git a/man/lt_single2abridged.Rd b/man/lt_single2abridged.Rd index 759404147..771fcc892 100644 --- a/man/lt_single2abridged.Rd +++ b/man/lt_single2abridged.Rd @@ -18,20 +18,18 @@ lt_single2abridged(lx, nLx, ex, Age = 1:length(lx) - 1, ...) \item{...}{optional args, not currently used.} } \value{ -Abridged lifetable in data.frame with columns -\itemize{ -\item{Age}{integer. Lower bound of abridged age class}, -\item{AgeInt}{integer. Age class widths.} -\item{nMx}{numeric. Age-specific central death rates.} -\item{nAx}{numeric. Average time spent in interval by those deceased in interval. } -\item{nqx}{numeric. Age-specific conditional death probabilities.} -\item{lx}{numeric. Lifetable survivorship} -\item{ndx}{numeric. Lifetable deaths distribution.} -\item{nLx}{numeric. Lifetable exposure.} -\item{Sx}{numeric. Survivor ratios in uniform 5-year age groups.} -\item{Tx}{numeric. Lifetable total years left to live above age x.} -\item{ex}{numeric. Age-specific remaining life expectancy.} -} +Abridged lifetable in \code{data.frame} with columns +\code{Age} integer. Lower bound of abridged age class +\code{AgeInt} integer. Age class widths. +\code{nMx} numeric. Age-specific central death rates. +\code{nAx} numeric. Average time spent in interval by those deceased in interval. +\code{nqx} numeric. Age-specific conditional death probabilities. +\code{lx} numeric. Lifetable survivorship +\code{ndx} numeric. Lifetable deaths distribution. +\code{nLx} numeric. Lifetable exposure. +\code{Sx} numeric. Survivor ratios in uniform 5-year age groups. +\code{Tx} numeric. Lifetable total years left to live above age x. +\code{ex} numeric. Age-specific remaining life expectancy. } \description{ Computes abridged life table columns based on the lx, nLx , and ex values from diff --git a/man/lt_single_mx.Rd b/man/lt_single_mx.Rd index 8ac46d130..d5d0dcbf7 100644 --- a/man/lt_single_mx.Rd +++ b/man/lt_single_mx.Rd @@ -58,17 +58,17 @@ lt_single_mx( \value{ Lifetable in data.frame with columns \itemize{ -\item{Age}{integer. Lower bound of abridged age class}, -\item{AgeInt}{integer. Age class widths.} -\item{nMx}{numeric. Age-specific central death rates.} -\item{nAx}{numeric. Average time spent in interval by those deceased in interval. } -\item{nqx}{numeric. Age-specific conditional death probabilities.} -\item{lx}{numeric. Lifetable survivorship} -\item{ndx}{numeric. Lifetable deaths distribution.} -\item{nLx}{numeric. Lifetable exposure.} -\item{Sx}{numeric. Survivor ratios in uniform 5-year age groups.} -\item{Tx}{numeric. Lifetable total years left to live above age x.} -\item{ex}{numeric. Age-specific remaining life expectancy.} +\item \code{Age} integer. Lower bound of abridged age class +\item \code{AgeInt} integer. Age class widths. +\item \code{nMx} numeric. Age-specific central death rates. +\item \code{nAx} numeric. Average time spent in interval by those deceased in interval. +\item \code{nqx} numeric. Age-specific conditional death probabilities. +\item \code{lx} numeric. Lifetable survivorship +\item \code{ndx} numeric. Lifetable deaths distribution. +\item \code{nLx} numeric. Lifetable exposure. +\item \code{Sx} numeric. Survivor ratios in uniform 5-year age groups. +\item \code{Tx} numeric. Lifetable total years left to live above age x. +\item \code{ex} numeric. Age-specific remaining life expectancy. } } \description{ diff --git a/man/lt_single_qx.Rd b/man/lt_single_qx.Rd index 1d243ca1b..a8896e816 100644 --- a/man/lt_single_qx.Rd +++ b/man/lt_single_qx.Rd @@ -58,17 +58,17 @@ lt_single_qx( \value{ Lifetable in data.frame with columns \itemize{ -\item{Age}{integer. Lower bound of abridged age class}, -\item{AgeInt}{integer. Age class widths.} -\item{nMx}{numeric. Age-specific central death rates.} -\item{nAx}{numeric. Average time spent in interval by those deceased in interval. } -\item{nqx}{numeric. Age-specific conditional death probabilities.} -\item{lx}{numeric. Lifetable survivorship} -\item{ndx}{numeric. Lifetable deaths distribution.} -\item{nLx}{numeric. Lifetable exposure.} -\item{Sx}{numeric. Survivor ratios in uniform single-year age groups.} -\item{Tx}{numeric. Lifetable total years left to live above age x.} -\item{ex}{numeric. Age-specific remaining life expectancy.} +\item \code{Age} integer. Lower bound of abridged age class, +\item \code{AgeInt} integer. Age class widths. +\item \code{nMx} numeric. Age-specific central death rates. +\item \code{nAx} numeric. Average time spent in interval by those deceased in interval. +\item \code{nqx} numeric. Age-specific conditional death probabilities. +\item \code{lx} numeric. Lifetable survivorship +\item \code{ndx} numeric. Lifetable deaths distribution. +\item \code{nLx} numeric. Lifetable exposure. +\item \code{Sx} numeric. Survivor ratios in uniform single-year age groups. +\item \code{Tx} numeric. Lifetable total years left to live above age x. +\item \code{ex} numeric. Age-specific remaining life expectancy. } } \description{ diff --git a/man/mig_calculate_rc.Rd b/man/mig_calculate_rc.Rd index c56805242..e61f1137a 100644 --- a/man/mig_calculate_rc.Rd +++ b/man/mig_calculate_rc.Rd @@ -22,11 +22,12 @@ In the full 13 parameter model, the migration rate at age x, \eqn{m(x)} is defin The first, second, third and fourth pieces of the equation represent pre-working age, working age, retirement and post-retirement age patterns, respectively. Models with less parameters gradually remove terms at the older ages. Parameters in each family are: \itemize{ -\item pre-working age: {a1, alpha1} -\item working age: {a2, alpha2, mu2, lambda2} -\item retirement: {a3, alpha3, mu3, lambda3} -\item post retirement: {a4, lambda4} +\item pre-working age: a1, alpha1 +\item working age: a2, alpha2, mu2, lambda2 +\item retirement: a3, alpha3, mu3, lambda3 +\item post retirement: a4, lambda4 } + For a specific family to be included, values for all parameters in that family must be specified. } \examples{