annuity: 'annuity'

In wbreymann/FEMS: R Package for Financial Enterprise Modelling and Simulation

annuity

Description

Constructor method for simple Annuity contracts. If interest payments are set, the cycle of interest rate payments is the same as the cycle for annuity payments.

Usage

annuity(start, nominal, ir, annuity, annuityFreq, maturity, role)

Arguments

start	a character reflecting a start date of the annuity.
nominal	a numeric to set the notional principal of the annuity, default is 0.0.
ir	a numeric to set the nominal interest rate, default is 0.0.
annuity	a numeric to set the next principal redemption payment.
annuityFreq	a character reflecting the frequency of redemption payments, default is "1 year".
maturity	a character reflecting the maturity of the annuity, default is "0 years".
role	a character reflecting the contract role, default is "long".

Value

an Annuity contract with specified attributes.

Examples

ann <- annuity("2013-12-31", nominal = 50000, ir = 0.02, maturity = "5 years")

wbreymann/FEMS documentation built on Dec. 8, 2022, 9:43 a.m.