hpipy.trans_data.TransactionData

class hpipy.trans_data.TransactionData(trans_data)

Bases: object

Transaction data class.

Represents the transaction data from which to create house price indices.

Parameters:

trans_data (PeriodTable | pd.DataFrame) – Data from which to create transactions.

trans_data

Data from which to create transactions.

Type:

PeriodTable | pd.DataFrame

trans_df

Transaction data.

Type:

pd.DataFrame

period_table

Period table.

Type:

pd.DataFrame

Example

>>> import pandas as pd
>>> from hpipy.trans_data import TransactionData
>>> trans_data = pd.DataFrame({
...     "prop_id": [1, 2, 3],
...     "trans_id": [1, 2, 3],
...     "price": [100, 200, 300],
...     "date": pd.to_datetime(["2020-01", "2021-01", "2020-02"]),
... })
>>> trans_data = TransactionData(trans_data)

Methods

__init__	Initialize transaction data.
create_forecast_periods	Abstract transaction forecast period method.
create_transactions	Abstract transaction creation method.

Attributes

trans_data
trans_df
period_table

trans_df: DataFrame

period_table: DataFrame

__init__(trans_data)

Initialize transaction data.

Parameters:

trans_data (PeriodTable | DataFrame)

Return type:

None

trans_data: PeriodTable | DataFrame

abstractmethod create_transactions(prop_id, trans_id, price, date=None, periodicity=None)

Abstract transaction creation method.

Parameters:

• prop_id (str | None)

• trans_id (str | None)

• price (str | None)

• date (str | None)

• periodicity (str | None)

Return type:

Self

abstractmethod create_forecast_periods(*args, **kwargs)

Abstract transaction forecast period method.

Parameters:

• args (Any)

• kwargs (Any)

Return type:

ndarray