Compare published return assumptions
compare_return_assumptionsRuns the same plan against several published capital market assumption sets and returns the success rate and median outcome under each, showing how far the answer moves with the return forecast used.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| pension | No | Yearly pension income. Default 0. | |
| sources | No | Source ids to compare. Defaults to all. | |
| allocations | No | Percentages summing to 100: [US stocks, international stocks, bonds, real estate, cash]. Default [60,10,25,5,0]. | |
| current_age | Yes | Current age of the primary person. | |
| ss_start_age | No | Age Social Security starts. Default 67. | |
| inflation_rate | No | Annual inflation as a percent, e.g. 2.5. Default 2.5. | |
| retirement_age | No | Age work income stops. Defaults to current age. | |
| returns_source | No | Which published return set to use (see list_return_assumption_sources). Default jpmorgan. | |
| annual_spending | Yes | Planned yearly spending in today's dollars. | |
| current_savings | Yes | Total invested portfolio today, in dollars. | |
| life_expectancy | No | Age the plan must last until. Default 92. | |
| social_security | No | Yearly Social Security in today's dollars. Default 0 — and 0 is reported as an explicit assumption, not hidden. | |
| pension_start_age | No | Age the pension starts. Default 65. | |
| monthly_contribution | No | Monthly savings until retirement. Default 0. |