R/modsData2018.R

In sinafala/svdComp5q0: Child/Child-Adult Mortality-Indexed Model Life Tables

#' SVD-Comp Models Data Set - 'mods2018'.
#'
#' @description An R object containing a hierarchy of lists that contain SVD-derived components,
#'     estimated model coefficients, and other parameter
#'     values necessary to predict new 1qx values using the SVD Component
#'     mortality model indexed by child/child-adult mortality implemented by
#'     the 'svdComp5q0()' function.  The model objects
#'     have been 'cleaned' to remove large collections
#'     of data that are not necessary to perform predictions - this dramatically
#'     reduces their size. This is the 2018 version of the models that replicates
#'     the \emph{Demography} paper.
#' @author Samuel J. Clark, \email{work@samclark.net}
#'
#' @format An R list object with members:
#' \describe{
#'   \item{\strong{Female}:}{
#'       \describe{
#'         \item{\strong{comps}: 4 raw SVD-derived components}{}
#'         \item{\strong{comps.sm}: 4 smoothed SVD-derived components}{}
#'         \item{\strong{aml}: lm() model object for adult mortality model}{}
#'         \item{\strong{v1}: lm() model object for v1}{}
#'         \item{\strong{v2}: lm() model object for v2}{}
#'         \item{\strong{v3}: lm() model object for v3}{}
#'         \item{\strong{v4}: lm() model object for v4}{}
#'         \item{\strong{offset}: offset used when calculating SVD}{}
#'         \item{\strong{q0}: lm() model object for mortality at age 0}{}
#'         \item{\strong{rownames}: row labels for the predicted values}{}
#'       }
#'     }
#'   \item{\strong{Male}:}{
#'       \describe{
#'         \item{\strong{comps}: 4 raw SVD-derived components}{}
#'         \item{\strong{comps.sm}: 4 smoothed SVD-derived components}{}
#'         \item{\strong{aml}: lm() model object for adult mortality model}{}
#'         \item{\strong{v1}: lm() model object for v1}{}
#'         \item{\strong{v2}: lm() model object for v2}{}
#'         \item{\strong{v3}: lm() model object for v3}{}
#'         \item{\strong{v4}: lm() model object for v4}{}
#'         \item{\strong{offset}: offset used when calculating SVD}{}
#'         \item{\strong{q0}: lm() model object for mortality at age 0}{}
#'         \item{\strong{rownames}: row labels for the predicted values}{}
#'       }
#'     }
#' }
#' @source See model development in \doi{doi:10.48550/arXiv.1612.01408} and \doi{doi:10.1007/s13524-019-00785-3}
"mods2018"

# load the model data: svd components and regression coefficients
load("./data/mods2018.RData")