compare_scenarios
Run 2-3 scenarios and compare their key_results side by side, with deltas against the first (baseline) scenario. Provide a 'scenarios' array where each entry is {name?, template, inputs} (each may set its own horizon, or pass a shared top-level 'horizon'). Optionally rank on 'compare_metric' with 'goal' ('max' default | 'min') to pick a winner, and set include_projections:true to also return per-period series.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| goal | No | Whether higher (max) or lower (min) is better for compare_metric. | max |
| horizon | No | Optional shared horizon applied to scenarios that don't set their own. | |
| scenarios | Yes | 2-3 scenarios to compare. Each: {name?, template, inputs, horizon?, period_label?} or {name?, metrics:[...]} for a custom model. | |
| compare_metric | No | Metric to rank scenarios on (optional). | |
| include_projections | No | Include each scenario's full per-period projections. |