Skip to content

Commit 07638ef

Browse files
committed
docs: some more docs
1 parent 5c21740 commit 07638ef

File tree

4 files changed

+21
-4
lines changed

4 files changed

+21
-4
lines changed

NAMESPACE

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
export(tr_bill_rates)
44
export(tr_curve_rates)
5+
export(tr_forward_rate)
56
export(tr_long_term_rate)
7+
export(tr_par_yields)
68
export(tr_real_long_term)
79
export(tr_real_yield_curve)
810
export(tr_yield_curve)

NEWS.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
# treasury (development version)
22

33
* Better docs
4-
* Support for treasury High Quality Market (HQM) Corporate Bond Yield Curve data
5-
* Support for treasury Nominal Coupon-Issue (TNC) Yield Curve data
4+
* Support for Treasury High Quality Market (HQM) Corporate Bond Yield Curve data
5+
* Support for Treasury Nominal Coupon-Issue (TNC) Yield Curve data
6+
* Support for Treasury Real Coupon-Issue (TRC) Yield Curve data
7+
* Support for Treasury Breakeven Inflation Curve (TBI curve) data
68

79
# treasury 0.1.0
810

R/yield-curve.R

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,10 @@ tr_curve_rates <- function(x = c("hqm", "tnc", "trc", "tbi"),
7171
do.call(rbind, res)
7272
}
7373

74-
tr_par_yield <- function(x = c("hqm", "tnc", "trc"),
75-
type = c("monthly", "end-of-month")) {
74+
#' @rdname tr_curve_rates
75+
#' @export
76+
tr_par_yields <- function(x = c("hqm", "tnc", "trc"),
77+
type = c("monthly", "end-of-month")) {
7678
x <- match.arg(x)
7779
type <- match.arg(type)
7880

@@ -95,6 +97,8 @@ tr_par_yield <- function(x = c("hqm", "tnc", "trc"),
9597
download_data(x, nms, 6L, "maturity", "par_yield")
9698
}
9799

100+
#' @rdname tr_curve_rates
101+
#' @export
98102
tr_forward_rate <- function(x = c("tnc", "trc", "tbi"),
99103
type = c("monthly", "end-of-month")) {
100104
x <- match.arg(x)

man/tr_curve_rates.Rd

Lines changed: 9 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)