getRetirementData: Return a individual's retirement vitals.
In twjacobs/oasdir: Estimates Social Security Benefits
Description
Usage
Arguments
Value
Description
Social Secuity Benefit (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
1
getRetirementData(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.
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.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Description Usage Arguments Value
Description
Social Secuity Benefit (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
1 | getRetirementData(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. |
Value
Named list of several retirement related values including estimated benefit beginning at various ages
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.