getPIAData: Return estimates individual's retirement benefits.

In twjacobs/oasdir: Estimates Social Security Benefits

Description

Provides an estimate of the monthly primary insurance amount (PIA) for benefits beginning at several ages based on data from a Social Security Statement (normal retirement) are calculated based on AIME using a specific retirement age (actually the age when benefits are started). Several retirement related variables are calculated and returned in a named list. This data can be used to calculate estimated primary insurance amount (PIA) if benefits begin at various ages (See getPIAData in this package).

Usage

getPIAData(retData = NULL, ssStmt = NULL, retireAge = NULL)

Arguments

ssStmt	the Social Security Statement as retrieved through read_xml_ssStatement()
retireAge	the age of reciepient when earnings end. If no age is given, full retirement age (FRA) will be used.
retDate	list of retirement related values as retrieved through getRetirementData

Value

Named list of several retirement related values including estimated benefit beginning at various ages

twjacobs/oasdir documentation built on July 28, 2019, 5:51 a.m.