call_report.fca.DomainDatasetColumn

class call_report.fca.DomainDatasetColumn(*, column: str, code: int | None)

Bases: object

One source variable’s contribution to a curated domain dataset.

Every declared variable answers two questions: which output column its values belong in, and which code its row is keyed by. A code-bearing schedule answers the second from its data, so code is None there and set only for a schedule that encodes the breakdown in its names.

Attributes:

columnstr

The curated output column this variable’s values land in.

codeint, optional

The code this variable belongs to, for a source whose breakdown is encoded in its variable names. None for a source that reports a code column, where the code comes from the data.

Examples

>>> from call_report.fca._domain_datasets import DomainDatasetColumn
>>> charge_off_agribusiness = DomainDatasetColumn(column="charge_off", code=110)
>>> charge_off_agribusiness.column
'charge_off'