set_interest_baseline()

Set the baseline real interest rates for projection years 1 through 5.

Usage

set_interest_baseline(
    ctx,
    records,
    *,
    strict=True,
    empty_measure="write",
)

Sets the annual real interest rate baseline values in the Inputs sheet. Each record’s TIME_PERIOD maps to a projection year header, and OBS_VALUE sets the corresponding cell in the Inputs!C17:G17 range.

Parameters

records: SeriesInput

A list of records, a single record dict, a tidy pandas/polars DataFrame, or a 1-D iterable of measure values in key order.

empty_measure: EmptyMeasure = "write"

How to treat rows with missing measure values (None or float NaN after DataFrame coercion). “write” (default) passes values through; “skip” drops them; “error” raises. Empty key fields always raise. Required record fields: - TIME_PERIOD: The projection year identifying the column in the baseline range. - OBS_VALUE: The real interest rate value for the projection year. Optional record fields: - INDICATOR: A constant identifying the series as real interest rate data. If supplied, expected value: “real_interest_rate”. - UNIT_MEASURE: The unit of measure for the interest rate values. If supplied, expected value: “PERCENT_PER_ANNUM”.

Returns

None: None

Applies the input updates to ctx.

Source Binding

Workbook range: Inputs!C17:G17 Layout: series Value type: float

Examples

set_interest_baseline(ctx, [ {‘TIME_PERIOD’: 1, ‘OBS_VALUE’: 4.0}, {‘TIME_PERIOD’: 2, ‘OBS_VALUE’: 4.0},])

set_interest_baseline(ctx, [4.0, 4.0])