PrincipalReceived-BondReturn-method: PrincipalReceived method, class BondReturn
In glennmschultz/BondLab: BondLab is a package for the analysis of fixed-income securities
Description
Usage
Arguments
See Also
Description
A method to get Principal Received over the
scenario horizon to the investor. Principal Received is reported
as the sum of scheduled principal received by the investor.
Usage
1
2
## S4 method for signature 'BondReturn'
PrincipalReceived(object)
Arguments
object
An S4 class of type BondReturn
See Also
Other Bond Scenario Analysis:
BondReturn-class,
BondScenario-class,
BondScenario,
CouponIncome,BondReturn-method,
HorizonCurrBal,BondReturn-method,
HorizonMos,BondReturn-method,
HorizonPrice,BondReturn-method,
HorizonReturn,BondReturn-method,
ReinvestmentIncome,BondReturn-method,
ScenarioHorizonMos,ScenarioCurve-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 Principal Received over the scenario horizon to the investor. Principal Received is reported as the sum of scheduled principal received by the investor.
Usage
1 2 | ## S4 method for signature 'BondReturn'
PrincipalReceived(object)
|
Arguments
object |
An S4 class of type BondReturn |
See Also
Other Bond Scenario Analysis:
BondReturn-class,
BondScenario-class,
BondScenario,
CouponIncome,BondReturn-method,
HorizonCurrBal,BondReturn-method,
HorizonMos,BondReturn-method,
HorizonPrice,BondReturn-method,
HorizonReturn,BondReturn-method,
ReinvestmentIncome,BondReturn-method,
ScenarioHorizonMos,ScenarioCurve-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.