set_shock_year()

Set the shock year in the Tiny-DSA Inputs sheet.

Usage

set_shock_year(
    ctx,
    records,
    *,
    strict=True,
)

Updates the value of the shock year, an integer between 1 and 5 that determines the first projection year in which the selected shock takes effect. Each record corresponds to the scalar shock year value; the OBS_VALUE field holds the integer year.

Parameters

records: Scalar | Record | Records

A bare scalar value, a single record dict, or a list of records. Required record fields: - OBS_VALUE: The integer year, from 1 to 5, in which the shock begins. Optional record fields: - PARAMETER: Identifies the record as belonging to the shock_year parameter. If supplied, expected value: “shock_year”.

Returns

None: None

Applies the input updates to ctx.

Source Binding

Workbook range: Inputs!B21 Layout: scalar Value type: int

Examples

set_shock_year(ctx, 2)