HorizonCurveShift: a constructor function of the class HorizonCurve

Description Usage Arguments See Also

View source: R/ScenarioConstructor.R

Description

a function to construct the HorizonCurve class. Currently supported scenarios

Usage

1
2
3
4
5
6
7
HorizonCurveShift(
  rates.data,
  settlement.date,
  horizon.months = 12,
  scenario = "NC",
  method = "dl"
)

Arguments

rates.data

A character string referencing a rates object

settlement.date

A character string the settlement date 'mm-dd-YYYY'

horizon.months

A numeric value the horizon in months

scenario

A character string the scenario

method

A character string indicating the fitting method ns = Nelson Siegel, dl = Diebond Lee, sv = Severson, asv = adjusted Severson, cs = cubic spline (not yet implemented). For additional details see the termstrc documentation.

See Also

Other Scenario Analysis: CouponIncome(), HorizonCurrBal(), HorizonMos(), HorizonPrice(), HorizonReturn(), Name,Scenario-method, PrepaidPrinReceived(), PrincipalReceived(), ReinvestmentIncome(), Scenario-class, ScenarioCurve-class, ScheduledPrinReceived()


glennmschultz/BondLab documentation built on May 11, 2021, 5:29 p.m.