pydeflate.deflate.deflator

Defines the deflator class

Classes

Deflator

Module Contents

class pydeflate.deflate.deflator.Deflator
base_year: int
exchange_obj: pydeflate.get_data.exchange_data.Exchange
deflator_obj: pydeflate.get_data.deflate_data.Data
deflator_method: str
source_currency: str = 'LCU'
target_currency: str = 'USA'
to_current: bool = False
_xe_df: pandas.DataFrame | None = None
_xe_deflator_df: pandas.DataFrame | None = None
_price_deflator_df: pandas.DataFrame | None = None

A class to produce deflators based on the given parameters.

Deflators take into account changes in prices and the evolution of currency exchange values. They compensate for both factors in order to produce a standard unit of measurement, regardless of the year of the flow.

Parameters:

  • base_year – the year in which the deflator equals 100 (if the source and target

  • equal). (currency are)

  • Exchange – the exchange rate object.

  • price – the price data oject.

  • source_currency – the ISO3 code of the country which uses the source currency

  • target_currency – the ISO3 code of the country which used the target currency

  • _deflator_df – the resulting DataFrame containing the deflators data.

__post_init__()
get_deflator() → pandas.DataFrame

Get the deflator DataFrame