Skip to contents

Create a scalar risk-free-rate assumption

Source: R/metric-context.R
ledgr_risk_free_rate.Rd

ledgr_risk_free_rate() records a scalar annual risk-free rate with optional manual provenance. It is a subordinate value inside ledgr_metric_context(), not a provider adapter.

Usage

ledgr_risk_free_rate(
  annual_rate,
  label = NULL,
  source = "manual",
  as_of = NULL
)

Arguments

annual_rate

Finite scalar annual rate as a decimal, greater than -1.

label

Optional non-empty display label.

source

Non-empty source label. The default is "manual".

as_of

Optional date for the manual rate. Values are normalized to Date.

Value

A ledgr_risk_free_rate object.

Articles

vignette("metrics-and-accounting", package = "ledgr") system.file("doc", "metrics-and-accounting.html", package = "ledgr")