Workbook language

The complete definition of an ARMID Lab workbook — its keys, steps, options, expressions and limits.

A workbook is a YAML 1.2 document. Both block style and flow style ({ key: value }, [a, b]) may be used, and comments start with #.

Page	Defines
File structure	The top-level keys `title`, `params` and `nodes`.
Parameters	Inputs shown as controls.
Steps	Every step a node can use, grouped by what it does.
Expressions and functions	The formula language of `filter`, `formula`, `aggregate` and `holdout`.
Layers	The named data layers a `series` step can read.
Limits	Rows, time and concurrency.
Editor and autocomplete	What the editor suggests, and its keys.

The three top-level keys of a workbook.

Inputs shown as controls on the dashboard and usable by name in expressions.

Every step a node can use.

The formula language of filter, formula, aggregate and holdout.

Named grid and regional layers a series step can read.

Rows, run time and concurrency.

What the workbook editor suggests where, and its keyboard shortcuts.