arpoon.rfixest.Fixest.get_data(r: bool = False, est_sample: bool | str = False)

Returns the relevant data.

If ‘r’ is True, it returns the R-compatible data. If ‘r’ is False and ‘est_sample’ is False or None, it returns the Python-compatible data. If ‘r’ is False and ‘est_sample’ is not False or None, it returns the Python-compatible data filtered based on the ‘est_sample’ parameter.

Parameters:
r : bool, optional

Whether to return R-compatible data.

est_sample : bool | str, optional

If ‘r’ is False, this parameter determines whether to filter the Python-compatible data based on the estimation sample.

Raises:

ValueError – If ‘r’ is True but ‘est_sample’ is not False or None.

Returns:

The relevant data based on the parameters.

Return type:

data

Note

The data could be in the format suitable for Python (Pandas or Polars dataframe) or R.