cashflow: Functions to return cash-flows from bonds and portfolio...

In gsk3/maRketSim: Market simulator for R

Description

These functions return the amounts and timings of cash flows from bond-type objects.

Usage

cashflow(x, mkt, ...)
## Default S3 method:
cashflow(x, mkt, ...)
## S3 method for class 'cash'
cashflow(x, mkt, future=TRUE, ...)
## S3 method for class 'bond'
cashflow(x,mkt,future=TRUE,f=x$f,...)
## S3 method for class 'portfolio.bond'
cashflow(x,mkt=x$orig.mkt,sort=FALSE,condense=TRUE,future=TRUE,...)
## S3 method for class 'account'
cashflow(x, mkt, ...)

Arguments

x	Bond or portfolio object
mkt	Market object under which to evaluate cash flows
future	TRUE/FALSE. Add in future=FALSE (past cash flows) for use with fv()
f	Frequency of coupon payments
sort	Sort by time then by amount
condense	Condensed output
...	Pass-alongs.

gsk3/maRketSim documentation built on May 17, 2019, 8:55 a.m.