HouseholdMember: HouseholdMember class

In R4GoodPersonalFinances: Make Optimal Financial Decisions

HouseholdMember class

Description

The HouseholdMember class aggregates information about a single member of a household.

Value

An object of class HouseholdMember.

Active bindings

max_age

The maximum age of the household member

mode

The Gompertz mode parameter

dispersion

The Gompertz dispersion parameter

Methods

Public methods

• HouseholdMember$new()

• HouseholdMember$get_name()

• HouseholdMember$get_birth_date()

• HouseholdMember$calc_age()

• HouseholdMember$get_lifespan()

• HouseholdMember$calc_life_expectancy()

• HouseholdMember$calc_survival_probability()

• HouseholdMember$get_events()

• HouseholdMember$set_event()

• HouseholdMember$clone()

---

Method new()

Creating a new object of class HouseholdMember

Usage

HouseholdMember$new(name, birth_date, mode = NULL, dispersion = NULL)

Arguments

name

The name of the member.

birth_date

The birth date of the household member in the format YYYY-MM-DD.

mode

The Gompertz mode parameter.

dispersion

The Gompertz dispersion parameter.

---

Method get_name()

Getting the name of the household member

Usage

HouseholdMember$get_name()

---

Method get_birth_date()

Getting the birth date of the household member

Usage

HouseholdMember$get_birth_date()

---

Method calc_age()

Calculating the age of the household member

Usage

HouseholdMember$calc_age(current_date = get_current_date())

Arguments

current_date

A date in the format "YYYY-MM-DD".

---

Method get_lifespan()

Calculating a lifespan of the household member

Usage

HouseholdMember$get_lifespan(current_date = get_current_date())

Arguments

current_date

A date in the format "YYYY-MM-DD".

---

Method calc_life_expectancy()

Calculating a life expectancy of the household member

Usage

HouseholdMember$calc_life_expectancy(current_date = get_current_date())

Arguments

current_date

A date in the format "YYYY-MM-DD".

---

Method calc_survival_probability()

Calculating a survival probability of the household member

Usage

HouseholdMember$calc_survival_probability(
  target_age,
  current_date = get_current_date()
)

Arguments

target_age

Target age (numeric, in years).

current_date

A date in the format "YYYY-MM-DD".

---

Method get_events()

Getting the events related to the household member

Usage

HouseholdMember$get_events()

---

Method set_event()

Setting an event related to the household member

Usage

HouseholdMember$set_event(event, start_age, end_age = Inf, years = Inf)

Arguments

event

The name of the event.

start_age

The age of the household member when the event starts.

end_age

The age of the household member when the event ends.

years

The number of years the event lasts.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

HouseholdMember$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

member <- HouseholdMember$new(
  name       = "Isabela",
  birth_date = "1980-07-15",
  mode       = 91,
  dispersion = 8.88
)
member$calc_age()
member$calc_life_expectancy()

R4GoodPersonalFinances documentation built on June 8, 2025, 11:18 a.m.