Python only
Functions without an R counterpart in the reference.
ALIAS_SCHEMA
module-attribute
ALIAS_SCHEMA = pa.schema(
[
("frame", pa.string()),
("unit", pa.string()),
("alias", pa.string()),
("source", pa.string()),
]
)
ATTR_SCHEMA
module-attribute
ATTR_SCHEMA = pa.schema(
[
("frame", pa.string()),
("unit", pa.string()),
("attribute", pa.string()),
("kind", pa.string()),
("value", pa.float64()),
("lower", pa.float64()),
("upper", pa.float64()),
("unit_of_measure", pa.string()),
("source", pa.string()),
("note", pa.string()),
]
)
Backend
dataclass
What a data argument is, and whether it is lazy.
NestedScalesError
Bases: ValueError
Raised for every user-facing error (R: .stop()).
NestedScalesWarning
Bases: UserWarning
Issued for every user-facing warning (R: .warn()).
ScaleDataset
dataclass
An opened store: data (a lazily read pyarrow Dataset) and scale.
ScaleSummary
dataclass
The quantitative view of a scale (R: summary() -> summary_Scale).
Verdict
dataclass
A yes/no answer with its evidence (R: a logical with attributes).
Truthy as ok, and equal to a bool of the same value, so
if scale_nests(...) and scale_nests(...) == True both read naturally.
offenders names the codes that broke the test; sizes carries the
per-unit totals of scale_is_uniform().
empty_aliases
empty_aliases() -> pa.Table
empty_attributes
empty_attributes() -> pa.Table