pash: Pace-Shape Analysis of Life-tables

#' Period Life-tables for Sweden 1755-2014 by Sex
#'
#' A dataset containing abridged period life-tables for Sweden years 1755-2014
#' by sex in five year period intervals.
#'
#' @details
#'   Infant and early childhood mortality are given in 1 and 4 year age
#'   intervals. Other age groups are given in 5 year intervals.
#'
#'   The dataset has been altered in form from the original provided by the
#'   Human Mortality database.
#'
#' @format
#'   A data frame with 2,496 rows and 12 variables:
#'   \describe{
#'     \item{sex}{Females or Males.}
#'     \item{period}{Period range in years [start, end].}
#'     \item{x}{Start of age interval in years.}
#'     \item{nmx}{Mortality rate in age interval [x, x+nx).}
#'     \item{nqx}{Probability to die within age interval [x, x+nx) given survival to x.}
#'     \item{nax}{Subject-time spent in age interval [x, x+nx) when dying in that interval.}
#'     \item{lx}{Life-table survivors at age x.}
#'     \item{ndx}{Deaths by life-table population in age interval [x, x+nx).}
#'     \item{nLx}{Total person-years lived by life-table population in age interval [x, x+nx).}
#'     \item{Tx}{Total person-years yet to live past age x by life-table population.}
#'     \item{ex}{Life expectancy at age x.}
#'   }
#'
#' @source
#'   The Human Mortality Database \url{http://www.mortality.org/}
"sweden5x5"

#' Period Life-table Survival Function for Austrian Males 1992
#'
#' An abridged period life-table lx column for Austrian males in 1992 used in
#' an example on life-table construction in Preston's demography textbook.
#'
#' @format
#'   A data frame with 19 rows and 2 variables:
#'   \describe{
#'     \item{x}{Start of age interval in years.}
#'     \item{lx}{Life-table survivors at age x.}
#'   }
#'
#' @source Preston, Samuel H., Patric Heuveline, and Michel Guillot. 2001.
#'         Demography. Oxford, UK: Blackwell, p. 51 and United Nations 1994.
#'
#' @export
prestons_lx <-
  data.frame(x = as.integer(c(0, 1, seq(5, 85, 5))),
             lx = as.integer(c(100000, 99133, 98986, 98910, 98815,
                               98334, 97704, 97151, 96492, 95588,
                               94195, 91937, 88711, 83845, 76377,
                               66225, 53803, 37441, 21134)))

#' Simulated Survival Times for Australian Males 1970-1972
#'
#' Simulated survival times for a cohort of 10,000 subjects following the
#' age-specific mortality rates of Australian males years 1970-1972.
#'
#' @details
#'   The survival times have been simulated using the Heligman-Pollard mortality
#'   model with parameters given by Heligman and Pollard (1980), Table 2.
#'
#' @format
#'   A numeric vector with 10,000 elements.
#'
#' @source
#'   Heligman, L., & Pollard, J. H. 1980. The Age Pattern of Mortality
#'   Journal of the Institute of Actuaries, 107(1), 49-80.
"australia_surv_times"

#' Simulated Period Life-table for Australian Males 1970-1972
#'
#' A simulated period life-table for the Australian male population years
#' 1970-1972 in single year age intervals.
#'
#' @details
#'   This life-table has been calculated from individual-level, continuous
#'   survival times simulated using the Heligman-Pollard mortality model with
#'   parameters given by Heligman and Pollard (1980), Table 2.
#'
#' @format
#'   A data frame with 101 rows and 10 variables:
#'   \describe{
#'     \item{x}{Start of age interval in years.}
#'     \item{nx}{Width of age interval in years.}
#'     \item{nmx}{Mortality rate in age interval [x, x+nx).}
#'     \item{nqx}{Probability to die within age interval [x, x+nx) given survival to x.}
#'     \item{nax}{Subject-time spent in age interval [x, x+nx) when dying in that interval.}
#'     \item{lx}{Life-table survivors at age x.}
#'     \item{ndx}{Deaths by life-table population in age interval [x, x+nx).}
#'     \item{nLx}{Total person-years lived by life-table population in age interval [x, x+nx).}
#'     \item{Tx}{Total person-years yet to live past age x by life-table population.}
#'     \item{ex}{Life expectancy at age x.}
#'   }
#'
#' @source
#'   Heligman, L., & Pollard, J. H. 1980. The Age Pattern of Mortality
#'   Journal of the Institute of Actuaries, 107(1), 49-80.
"australia_1y"

#' Simulated Abridged Period Life-table for Australian Males 1970-1972
#'
#' A simulated abridged period life-table for the Australian male population
#' years 1970-1972 in 10 year age intervals with smaller intervals for
#' infancy and childhood.
#'
#' @details
#'   This life-table has been calculated from individual-level, continuous
#'   survival times simulated using the Heligman-Pollard mortality model with
#'   parameters given by Heligman and Pollard (1980), Table 2.
#'
#' @format
#'   A data frame with 13 rows and 10 variables:
#'   \describe{
#'     \item{x}{Start of age interval in years.}
#'     \item{nx}{Width of age interval in years.}
#'     \item{nmx}{Mortality rate in age interval [x, x+nx).}
#'     \item{nqx}{Probability to die within age interval [x, x+nx) given survival to x.}
#'     \item{nax}{Subject-time spent in age interval [x, x+nx) when dying in that interval.}
#'     \item{lx}{Life-table survivors at age x.}
#'     \item{ndx}{Deaths by life-table population in age interval [x, x+nx).}
#'     \item{nLx}{Total person-years lived by life-table population in age interval [x, x+nx).}
#'     \item{Tx}{Total person-years yet to live past age x by life-table population.}
#'     \item{ex}{Life expectancy at age x.}
#'   }
#'
#' @source
#'   Heligman, L., & Pollard, J. H. 1980. The Age Pattern of Mortality
#'   Journal of the Institute of Actuaries, 107(1), 49-80.
"australia_10y"