← Python API
vraven.darkside · class

AnalysisResult

AnalysisResult(analysis: 'str', metrics: 'dict[str, Any]', tables: 'dict[str, Any]' = <factory>, metadata: 'dict[str, Any]' = <factory>, warnings: 'list[str]' = <factory>, limitations: 'list[str]' = <factory>, schema_version: 'str' = 'vraven.darkside.v1') -> None

Base result shared by every DarkSide analysis.

``analysis`` is a stable machine-readable identifier. ``metrics`` contains
scalar summary values. ``tables`` stores arrays or row records used by
figures. Causal and observational claims are kept explicit in ``metadata``.

Usage

from vraven.darkside import AnalysisResult

value = AnalysisResult(...)

Methods

figure(self, *, mode: 'str' = 'publication_light')

Render one standalone figure through the shared VRAVEN theme.

save_json(self, path: 'str | Path') -> 'Path'

Public method.

summary(self) -> 'dict[str, Any]'

Public method.

to_dict(self) -> 'dict[str, Any]'

Public method.

Source of truthThis page is generated from the checked-out public symbol, signature, and docstring. Pin the package version for reproducible work.