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

In eaoestergaard/UNPIE: UNPIE Understanding Pensions In Europe

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

fv.annuity.scenario(
  pmt = 0,
  nper = 1,
  mu = 0,
  sigma = 0,
  convRate = 1,
  nScenarios = 1,
  returnScenarios = FALSE,
  quantiles = c(0, 0.25, 0.5, 0.75, 1),
  seed = NULL
)

Arguments

pmt	The payment (real) made each period (annuity). Must be entered as a negative number.
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
returnScenarios	Should the scenarios be returned
quantiles	Quantile scenarios to be returned. Should be a numeric vector of probabilities with values in [0,1]
seed	Integer vector, containing the random number generator (RNG) state for random number generation in R

Examples

fv.annuity.scenario(pmt=-1000,nper=25,mu=0.03,sigma=0.08,convRate=0.05,nScenarios=100,returnScenarios=FALSE,quantiles=c(0,0.25,0.5,0.75,1),seed=NULL)

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