docs: add another related package and rename HQM data function for now

m-muecke · May 2, 2024 · ecb8185 · ecb8185
1 parent b5ce5d9
commit ecb8185
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 6 deletions.
diff --git a/NAMESPACE b/NAMESPACE
@@ -1,8 +1,8 @@
 # Generated by roxygen2: do not edit by hand
 
 export(tr_bill_rates)
+export(tr_hqm)
 export(tr_hqm_pars)
-export(tr_hqm_yield_curve)
 export(tr_long_term_rate)
 export(tr_real_long_term)
 export(tr_real_yield_curve)

diff --git a/R/yield-curve.R b/R/yield-curve.R
@@ -8,7 +8,7 @@
 #'   `spot_rate`.
 #' @family yield curve
 #' @export
-tr_hqm_yield_curve <- function(x = c("average", "end-of-month"), year = NULL) {
+tr_hqm <- function(x = c("average", "end-of-month"), year = NULL) {
   stopifnot(is_count_or_null(year), 1984L <= year, year <= 2028L)
   x <- match.arg(x)
   x <- if (x == "average") "hqm" else "hqmeom"
@@ -48,7 +48,7 @@ tr_hqm_yield_curve <- function(x = c("average", "end-of-month"), year = NULL) {
   do.call(rbind, res)
 }
 
-#' @rdname tr_hqm_yield_curve
+#' @rdname tr_hqm
 #' @export
 tr_hqm_pars <- function(x = c("average", "end-of-month")) {
   x <- match.arg(x)

diff --git a/README.Rmd b/README.Rmd
@@ -78,3 +78,4 @@ subset(yield_curve, maturity == "10 year") |>
 ## Related work
 
 - [ustyc](https://github.com/mrbcuda/ustyc) - R package to download and parse the US Treasury yield curve data
+- [ustfd](https://github.com/groditi/ustfd) - R client for US Treasury Fiscal Data API
diff --git a/README.md b/README.md
@@ -62,3 +62,5 @@ yield_curve
 
 - [ustyc](https://github.com/mrbcuda/ustyc) - R package to download and
   parse the US Treasury yield curve data
+- [ustfd](https://github.com/groditi/ustfd) - R client for US Treasury
+  Fiscal Data API
diff --git a/man/tr_hqm_yield_curve.Rd → man/tr_hqm.Rd b/man/tr_hqm_yield_curve.Rd → man/tr_hqm.Rd