docs: add missing section for pkgdown

m-muecke · May 2, 2024 · eb9042e · eb9042e
1 parent e270e21
commit eb9042e
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 0 deletions.
diff --git a/R/yield-curve.R b/R/yield-curve.R
@@ -6,6 +6,7 @@
 #'   If `NULL`, then all available years are downloaded.
 #' @returns A `data.frame()` with the following columns: `yearmonth`, `maturity`,
 #'   `yield`.
+#' @family yield curve
 #' @export
 tr_hqm <- function(x = c("average", "end-of-month"), year = NULL) {
   stopifnot(is_count_or_null(year), 1984L <= year, year <= 2028L)

diff --git a/_pkgdown.yml b/_pkgdown.yml
@@ -11,3 +11,7 @@ reference:
     - tr_long_term_rate
     - tr_real_yield_curve
     - tr_real_long_term
+
+  - subtitle: Corporate Bond Yield Curve
+    contents:
+    - tr_hqm
diff --git a/man/tr_hqm.Rd b/man/tr_hqm.Rd