Report Metrics
Collects Dashboard Data from any analysis components plus your own metrics into one report module file (04_metrics/<module>.json: metrics, green/amber/red flags, maps, sources, plugin version), ready for the report and its scorecard.
Overview
Collects Dashboard Data from any analysis components plus your own metrics into one report module file (04_metrics/<module>.json: metrics, green/amber/red flags, maps, sources, plugin version), ready for the report and its scorecard.
Inputs (18)
- Module (Text): Report module code, e.g. C1, C2, D1, F2
- Dashboard Data (Text): Dashboard Data JSON from any Enzyme analysis components (one per item)
- Prefixes (Text): Optional key prefix per Dashboard item, e.g. 'slope', 'wind_ne', 'storm_100y'
- Keys (Text): Extra metric keys, e.g. elev_min_m, retention_volume_m3
- Values (Number): Values for Keys (same order)
- Units (Text): Units for Keys (m, ha, %, m3...)
- Scopes (Text): Scope per key: site (default), buffer_1km, buffer_5km...
- FlagThemes (Text): Scorecard themes, e.g. Buildability, Flood & drainage, Climate comfort
- FlagKeys (Text): Metric key rated for each theme
- Amber (Number): Amber threshold per flag
- Red (Number): Red threshold per flag (Red > Amber: higher is worse; Red < Amber: lower is worse)
- Sources (Text): Input datasets as 'dataset | version | resolution | date'
- Maps (Text): Map image files for this module (e.g. from Export Views)
- Captions (Text): Caption per map
- Confidence (Text): field-verified, modelled or estimated
- Folder (Text): Project folder (04_metrics is added) or the 04_metrics folder itself
- Merge (Boolean): Keep metrics already in the file from other definitions and replace only this run's keys
- Write (Boolean): Write the file (use a button)
Outputs (5)
- JSON (Text): The module file content
- Scorecard (Text): Theme: rating (value vs thresholds)
- Metrics (Text): key = value unit, for checking
- File (Text): Path written (empty until Write)
- Info (Text): Component information and interpretation
Method, assumptions and simplifications
The same notes appear in the component's Info output.
Method
- Reads every Dashboard Data JSON item: each Metrics entry whose Value starts with a number becomes a metric (key = Prefix + snake_case name, %, > and < spelled out; _pct added for %), and each BandAreas entry becomes an area metric in ha (area / 10 000).
- Adds the hand-entered Keys, Values, Units and Scopes (scope defaults to site). Without Prefixes, several Dashboard items get d1, d2... prefixes.
- Each flag rates one metric: if Red ≥ Amber higher is worse (red when value ≥ Red, amber when ≥ Amber), otherwise lower is worse (red when ≤ Red, amber when ≤ Amber); n/a when the metric is missing.
- Builds the module JSON (module, plugin version, run date, inputs from Sources split on |, metrics, flags, maps with captions, confidence). With Merge on, metrics, flags, maps and inputs already in the existing file are kept and only this run's keys are replaced.
- Writes Folder/04_metrics/Module.json when Write is True.
Assumptions
- The model is in metres, so areas in m² convert to ha.
- Metric keys are unique per key and scope; the last value wins.
Simplifications and limits
- Flags inherited from an existing file are not re-rated against new values; only this run's flag rules are evaluated.
- Metric values are parsed from display text, so precision is limited to what the source component printed.
Workflow
- Dashboard Data from Analysis Heatmap, Analysis Difference, Fast CFD, Noise... -> Dashboard Data. Saved Files of Advanced Export Views -> Maps.
- The 04_metrics files feed the Deep Site Analysis report and scorecard.