requiredSavingsForMinimumAnnuity: Finds the required savings for minimum annuity

In eaoestergaard/UNPIE: UNPIE Understanding Pensions In Europe

Finds the required savings for minimum annuity

Description

Finds the required savings for minimum annuity

Usage

requiredSavingsForMinimumAnnuity(
  nper = 1,
  mu = 0,
  sigma = 0,
  convRate = 1,
  nScenarios = 1,
  minPayouy = 1000,
  prob = 0.95,
  seed = NULL,
  print = FALSE,
  returnScenarios = FALSE
)

Arguments

nper	The total number of payment periods. Default is one period
mu	The expected interest real return per period. Default is zero. Must be entered as decimal
sigma	Volatility of expected interest real return per period. Default is zero. Must be entered as decimal
convRate	The conversion rate. Default is one. Must be entered as decimal
nScenarios	The total number of scenarios to be made. Default is one scenario
minPayouy	The minimum desired yearly pension payout/target.
prob	Probability to reach minimum desired yearly pension payout. Must be entered as decimal
seed	Integer vector, containing the random number generator (RNG) state for random number generation in R
print	Should the scenarios be displayed in plot
returnScenarios	Should the scenarios be returned in a matrix

Examples

requiredSavingsForMinimumAnnuity(nper=1,mu=0,sigma=0,convRate=1,nScenarios=1,minPayouy = 1000, prob = 0.95, seed =NULL,print=FALSE,returnScenarios=FALSE)

eaoestergaard/UNPIE documentation built on Aug. 23, 2022, 2:28 a.m.