R/agg_sim_dat.R

In actxps: Create Actuarial Experience Studies: Prepare Data, Summarize Results, and Create Reports

#' Aggregate simulated annuity data
#'
#' A pre-aggregated version of surrender and withdrawal experience from the
#' simulated data sets `census_dat`, `withdrawals`, and `account_vals`. This
#' data is theoretical only and does not represent the experience on any
#' specific product.
#'
#' @format A data frame containing summarized experience study results grouped
#' by policy year, income guarantee presence, tax-qualified status, and product.
#'
#' @details
#'
#' \describe{
#'   \item{pol_yr}{Policy year}
#'   \item{inc_guar}{Indicates whether the policy was issued with an income
#'   guarantee}
#'   \item{qual}{Indicates whether the policy was purchased with tax-qualified
#'   funds}
#'   \item{product}{Product: a, b, or c}
#'   \item{exposure_n}{Sum of policy year exposures by count}
#'   \item{claims_n}{Sum of claim counts}
#'   \item{av}{Sum of account value}
#'   \item{exposure_amt}{Sum of policy year exposures weighted by account value}
#'   \item{claims_amt}{Sum of claims weighted by account value}
#'   \item{av_sq}{Sum of squared account values}
#'   \item{n}{Number of exposure records}
#'   \item{wd}{Sum of partial withdrawal transactions}
#'   \item{wd_n}{Count of partial withdrawal transactions}
#'   \item{wd_flag}{Count of exposure records with partial withdrawal
#'   transactions}
#'   \item{wd_sq}{Sum of squared partial withdrawal transactions}
#'   \item{av_w_wd}{Sum of account value for exposure records with partial
#'   withdrawal transactions}
#' }
#' @seealso [census_dat]
#' @name agg_sim_dat

NULL
#' @rdname agg_sim_dat
"agg_sim_dat"