R/data_documentation.R

In vitality: Fitting Routines for the Vitality Family of Mortality Models

#' @name swedish_females
#' @title Swedish Female Mortality Data
#' @description Period mortality data for Swedish females experiencing mortality
#' in the year 2000. Columns follow standard life-table naming conventions.
#' @docType data
#' @usage swedish_females
#' @format A \code{data.frame} object
#' @source Human Mortality Database
#' 
#' @name rainbow_trout_for_k
#' @title Sample Rainbow Trout Data
#' @description Sample survival data for rainbow trout. Columns include "days" and "survival" (cumulative survival proportion by day).
#' @docType data
#' @usage rainbow_trout_for_k
#' @format matrix
#' @source http://cbr.washington.edu/analysis/vitality
NULL