ppmt: Principal portion of annuity payment

View source: R/ppmt.R

ppmtR Documentation

Principal portion of annuity payment

Description

Calculation of principal repayment portion of an anuity payment.

Usage

ppmt(irate, per, nper, pv, fv = 0, type = "immediate", silent = FALSE)

Arguments

irate

Interest rate per period (see nper) as fraction (i.e. 5% is .05 or 1/20)

per

period of interest

nper

Number of interest periods as integer (no fractions)

pv

Present value

fv

Future value (default is zero)

type

type of the annuity: due or immediate?

silent

Should warning messages be suppressed? Default is no.

Value

principal repayment

Source

builds heavily on https://gist.github.com/raadk/dcd503815bbb271484ff

Examples

ppmt(.1, 1, 1, -1000) # a single period >> entire principal is repaid immediately

ppmt(.1, 1:5, 5, -1000) # see five payments of five; the amount of principal goes up


jla-data/TVM documentation built on Feb. 3, 2024, 8:48 p.m.