hpipy.price_index.HedonicIndex.create_index

classmethod HedonicIndex.create_index(trans_data, prop_id=None, trans_id=None, price=None, seq_only=True, max_period=None, smooth=False, periodicity=None, min_date=None, max_date=None, adj_type=None, **kwargs)

Create the index.

Parameters:

• trans_data (TransactionData | PeriodTable | pd.DataFrame) – Input transaction data.

• prop_id (str | None, optional) – Property identifier. Defaults to None.

• trans_id (str | None, optional) – Transaction identifier. Defaults to None.

• price (str | None, optional) – Price column name. Defaults to None.

• seq_only (bool, optional) – Sequential only. Defaults to True.

• max_period (int | None, optional) – Maximum index period. Defaults to None.

• smooth (bool, optional) – Smooth the index. Defaults to False.

• periodicity (str | None, optional) – Periodicity of the index. Defaults to None.

• min_date (str | None, optional) – Minimum date for the index. Defaults to None.

• max_date (str | None, optional) – Maximum date for the index. Defaults to None.

• adj_type (str | None, optional) – Adjustment type. Defaults to None.

• **kwargs – Additional keyword arguments.

Returns:

Index object.

Return type:

Self