loan: 'loan'

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

loan

Description

Constructor method for simple LinearAmortizer contracts.

Usage

loan(start, maturity, nominal, ir, irFreq, role, amortFreq, amort)

Arguments

start	a character reflecting the start date of the loan.
maturity	a character reflecting the maturity of the loan, default is "0 years".
nominal	a numeric to set the notional principal of the loan, default is 0.0.
ir	a numeric to set the nominal interest rate, default is 0.0.
irFreq	a character reflecting the frequency of interest rate payments, default is "1 year".
role	a character reflecting the contract role. default is "long".
amortFreq	a character reflecting the frequency of principal redemption payments, default is "1 year".
amort	a numeric to set the amount of principal redemption.

Value

a LinearAmortizer contrat with specified attributes.

Examples

l <- loan("2013-12-31", maturity = "5 years", nominal = 50000, 
           ir = 0.02, irFreq = "1 years", amortFreq = "1 years")
           

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