maximumSpendingForMinimumRuinTimeV2: Calculates scenarios of future value of annuity payments (fv)...

View source: R/maximumSpendingForMinimumRuinTimeV2.R

maximumSpendingForMinimumRuinTimeV2R Documentation

Calculates scenarios of future value of annuity payments (fv) with stochastic returns

Description

Calculates scenarios of future value of annuity payments (fv) with stochastic returns

Usage

maximumSpendingForMinimumRuinTimeV2(
  wealth = 14000,
  minumumRuinTime = 16,
  mu = 0.03,
  sigma = 0.08,
  nScenarios = 200,
  prob = 0.9,
  seed = NULL
)

Arguments

wealth

The wealth at retirement. Must be entered as a positive number

minumumRuinTime

Minimum time to ruin. Must be entered as a positive integer

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

nScenarios

The total number of scenarios to be made. Default is one scenario

prob

Probability to exceed minimum time to ruin. Must be entered as decimal.

seed

Integer vector, containing the random number generator (RNG) state for random number generation in R

Examples

maximumSpendingForMinimumRuinTimeV2(wealth=14000,minumumRuinTime = 16,mu=0.03,sigma=0.08,nScenarios=200, prob = 0.9, seed =NULL)


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