addPerson.sim: Add Person to persons list in a simulation

In rexmacey/aasim: Asset Allocation Simulation

Add Person to persons list in a simulation

Description

Add Person to persons list in a simulation

Usage

addPerson.sim(
  sim,
  name,
  initials,
  birthDate,
  gender,
  retireAge,
  mort.factor = 1,
  mort.adj.years = 0
)

Arguments

sim	Object of type sim (simulation)
name	Name of person
initials	Initials or short name, useful for display
birthDate	Birth date to determine current age, format YYYY-MM-DD.
gender	'M' or 'Male' or 'F' or 'Female'
retireAge	Retirement age.
mort.factor	Mortality factor, default = 1. This is multiplied by each mortality rate. Values >1 decrease life expectancy.
mort.adj.years	Mortality adjustment, default = 0. This value is added to each generated age at death.

Value

sim object with person added to simulation

Examples

## Not run: sim1 <- addPerson.sim(sim, name, initials, birthDate, gender,
retireAge, mort.factor, mort.adj.years)
## End(Not run)
## Not run: sim1<-addPerson.sim(sim1,"Rex Macey","RM",56,"M",65,1.0, 0.0)

rexmacey/aasim documentation built on Oct. 29, 2024, 9:30 a.m.