rdtools.plotting.degradation_timeseries_plot

rdtools.plotting.degradation_timeseries_plot(yoy_info, rolling_days=365, include_ci=True, fig=None, plot_color=None, ci_color=None, **kwargs)

Plot resampled time series of degradation trend with time

Parameters:

  • yoy_info (dict) --

    a dictionary with keys:

    • YoY_values - pandas series of right-labeled year on year slopes

  • rolling_days (int, default 365) -- Number of days for rolling window. Note that the window must contain at least 50% of datapoints to be included in rolling plot.

  • include_ci (bool, default True) -- calculate and plot 2-sigma confidence intervals along with rolling median

  • fig (matplotlib, optional) -- fig object to add new plot to (first set of axes only)

  • plot_color (str, optional) -- color of the timeseries trendline

  • ci_color (str, optional) -- color of the confidence interval 'fuzz'

  • kwargs -- Extra parameters passed to matplotlib.pyplot.axis.plot()

Note

It should be noted that yoy_info is an output from rdtools.degradation.degradation_year_on_year().

Return type:

matplotlib.figure.Figure