bayesline.api.equity.column_descriptor

bayesline.api.equity.column_descriptor#

bayesline.api.equity.column_descriptor(name: str, column: AnyReportColumnSettings[Never], base: MetricDescriptor) → MetricDescriptor#

Describe a column asked for under name, from its metric’s descriptor.

name names it; the column’s leg sets the family role, its denominator whether it is normalised and whether it keeps a currency, and its dates its time aggregation. Everything else is the base’s. The denominator re-qualifies only a currency amount, a base qualified as normalised or by its currency; a dimensionless base keeps its qualifiers whatever the denominator says.

Parameters#

namestr

The name the column answers under.

columnAnyReportColumnSettings[Resolved]

A resolved column.

baseMetricDescriptor

The report’s descriptor of the column’s metric.

Returns#

MetricDescriptor

The column’s descriptor.