glucopy.metrics.iqr

glucopy.metrics.iqr(df: DataFrame, per_day: bool = False, interpolation: str = 'linear')

Calculates the Interquartile Range (IQR) of the CGM values.

Parameters:

• df (pandas.DataFrame) – DataFrame containing the CGM values. The dataframe must contain ‘CGM’ and ‘Day’ columns present in glucopy.Gframe.data.

• per_day (bool, default False) – If True, returns a pandas.Series with the interquartile range for each day. If False, returns the interquartile range for the entire dataset.

• interpolation (str, default 'linear') –

  This optional parameter specifies the interpolation method to use, when the desired quantile lies between two data points i and j. Can be one of the following:

  • ’linear’: i + (j - i) * fraction, where fraction is the fractional part of the index surrounded by i and j.

  • ’lower’: i.

  • ’higher’: j.

  • ’nearest’: i or j, whichever is nearest.

  • ’midpoint’: (i + j) / 2.

Returns:

iqr – Interquartile range of the CGM values.

Return type:

float | pandas.Series

Notes

This function is meant to be used by glucopy.Gframe.iqr()