ScheduledPrinReceived-MortgageReturn-method: ScheduledPrinReceived method, class MortgageReturn
In glennmschultz/BondLab: BondLab is a package for the analysis of fixed-income securities
Description
Usage
Arguments
See Also
Description
A method to get the ScheduledPrinRecieved paid to the
investor over the scenario horizon. ScheduledPrinReceived is reported as
the sum of the sceduled principal received over the horizon.
Usage
1
2
## S4 method for signature 'MortgageReturn'
ScheduledPrinReceived(object)
Arguments
object
An S4 class of type MortgageReturn
See Also
Other Mortgage Scenario Analysis:
CouponIncome,MortgageReturn-method,
HorizonCurrBal,MortgageReturn-method,
HorizonMos,MortgageReturn-method,
HorizonPrice,MortgageReturn-method,
HorizonReturn,MortgageReturn-method,
MortgageReturn-class,
MortgageScenario-class,
PrepaidPrinReceived,MortgageReturn-method,
ReinvestmentIncome,MortgageReturn-method
glennmschultz/BondLab documentation built on May 11, 2021, 5:29 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Description Usage Arguments See Also
Description
A method to get the ScheduledPrinRecieved paid to the investor over the scenario horizon. ScheduledPrinReceived is reported as the sum of the sceduled principal received over the horizon.
Usage
1 2 | ## S4 method for signature 'MortgageReturn'
ScheduledPrinReceived(object)
|
Arguments
object |
An S4 class of type MortgageReturn |
See Also
Other Mortgage Scenario Analysis:
CouponIncome,MortgageReturn-method,
HorizonCurrBal,MortgageReturn-method,
HorizonMos,MortgageReturn-method,
HorizonPrice,MortgageReturn-method,
HorizonReturn,MortgageReturn-method,
MortgageReturn-class,
MortgageScenario-class,
PrepaidPrinReceived,MortgageReturn-method,
ReinvestmentIncome,MortgageReturn-method
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.