tki.dimensions.TemporalDimension

class tki.dimensions.TemporalDimension(name: str, dependent_dimensions: List[str] | None = None, value: str = '*', bins: int = 0, date_format: str | None = None, freq: str | None = None)

Dimension for temporal data.

Parameters

namestr

Name of column in Dataset

dependent_dimensionsList[str]

List of dependent dimensions. e.g. Country -> Region

valuestr

Current value reducing the Subspace. Defaults to ‘*’ aka all

binsint

Number of bins to split the data. 0 means no splitting. Defaults to 10

date_formatstr

Will be used to convert dates as strings to Datetime object. Defaults to None

freqstr

Frequency string to group the data. E.g. ‘1Y’ or ‘M’ Defaults to None

__init__(name: str, dependent_dimensions: List[str] | None = None, value: str = '*', bins: int = 0, date_format: str | None = None, freq: str | None = None)

Methods

__init__(name[, dependent_dimensions, ...])
preprocess(data)	Applies preprocessing steps to the values of the dimension.

Attributes

grouper	Returns pandas.Grouper to use for the dimension.
is_cardinal
is_nominal
is_ordinal
is_temporal