okama.AssetList.get_dividend_mean_growth_rate

AssetList.get_dividend_mean_growth_rate(period=5)

Calculate geometric mean of annual dividends growth rate time series for a given trailing period.

Growth rate is taken for full calendar annual dividends.

Parameters:
periodint, default 5

Growth rate trailing period in years. Period should be a positive integer and not exceed the available data period_length.

Returns:
Series

Dividend growth geometric mean value for each asset.

See also

dividend_yield

Dividend yield time series.

dividend_yield_annual

Calendar year dividend yield time series.

dividends_annual

Calendar year dividends.

dividend_paying_years

Number of years of consecutive dividend payments.

dividend_growing_years

Number of years when the annual dividend was growing.

get_dividend_mean_yield

Arithmetic mean for annual dividend yield.

Examples

>>> x = ok.AssetList(['T.US', 'XOM.US'], first_date='1984-01', last_date='1994-12')
>>> x.get_dividend_mean_growth_rate(period=3)
T.US      0.020067
XOM.US    0.024281
dtype: float64