View source: R/download_data_risk_free.R
| download_data_risk_free | R Documentation |
Downloads pre-processed risk-free rate data from the
tidy-finance/risk-free dataset on HuggingFace. The dataset is
updated monthly via a scheduled GitHub Actions workflow that splices the
3-Month Treasury Bill Secondary Market Rate (pre-2001) with the 4-Week
Treasury Bill Secondary Market Rate (from 2001 onwards) sourced from FRED.
For monthly data, the monthly TB3MS series is spliced with the daily DTB4WK
series aggregated to month-end. For daily data, the daily DTB3 series is
spliced with the daily DTB4WK series, both at the business-day frequency
provided by FRED.
download_data_risk_free(
start_date = NULL,
end_date = NULL,
frequency = "monthly"
)
start_date |
Optional. A character string or Date object in "YYYY-MM-DD" format specifying the start date for the data. If not provided, the full dataset is returned. |
end_date |
Optional. A character string or Date object in "YYYY-MM-DD" format specifying the end date for the data. If not provided, the full dataset is returned. |
frequency |
A character string, either |
Both series are quoted as annualised bank discount rates on a
360-day basis. Given an annualised discount rate d and a T-bill
with n days to maturity, the holding-period return is
HPR = d * n/360 / (1 - d * n/360), which is then converted to the
target period length via (1 + HPR)^(target/source) - 1.
The series are spliced at 2001-07-01:
Pre-2001: TB3MS (monthly) or DTB3 (daily), 3-month T-bill
with n = 90. Monthly conversion uses exponent 1/3; daily
conversion uses exponent 1/63 (approx. trading days per
quarter).
From 2001: DTB4WK, 4-week T-bill with n = 28. For monthly
data, the last non-NA observation per calendar month is taken
and the exponent is 365/(28*12). For daily data, observations
are used as-is and the exponent is 1/20 (approx. trading days
per 4-week period).
Business-day gaps in the daily series (e.g. holidays) are handled by forward-filling the most recent available rate.
Monthly data starts in 1934-01-01 (TB3MS). Daily data starts in 1954-01-04 due to the availability of DTB3.
A tibble with two columns:
The date of the observation.
The risk-free rate for the period.
Other download functions:
download_data(),
download_data_constituents(),
download_data_factors_ff(),
download_data_factors_q(),
download_data_fred(),
download_data_huggingface(),
download_data_jkp(),
download_data_macro_predictors(),
download_data_osap(),
download_data_pastor_stambaugh(),
download_data_stambaugh_yuan(),
download_data_stock_prices(),
download_factor_library_grid(),
download_factor_library_ids()
download_data_risk_free("2020-01-01", "2020-12-31")
download_data_risk_free(
"2020-01-01", "2020-12-31", frequency = "daily"
)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.