set_shock_type()

Set the shock type for the scenario configuration.

Usage

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

Updates the shock type in the Inputs sheet to specify which macroeconomic or fiscal parameter the shock affects. The OBS_VALUE field of the record is written to the scalar cell Inputs!B22.

Parameters

records: Scalar | Record | Records

A bare scalar value, a single record dict, or a list of records. Required record fields: - OBS_VALUE: The shock type code: 1 for real GDP growth, 2 for real interest rate, 3 for primary balance. Optional record fields: - PARAMETER: Identifies the conceptual parameter being configured. If supplied, expected value: “shock_type”.

Returns

None: None

Applies the input updates to ctx.

Source Binding

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

Examples

set_shock_type(ctx, 1)