Skip to content

Commit

Permalink
change "all days combined -> "the entire dataset"
Browse files Browse the repository at this point in the history
  • Loading branch information
@Deigoodle
Deigoodle committed Feb 14, 2024
1 parent 9813ccb commit 3129180
Show file tree
Hide file tree
Showing 6 changed files with 21 additions and 21 deletions.
32 changes: 16 additions & 16 deletions glucopy/classes/Gframe.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ def mean(self,
Parameters
----------
per_day : bool, default False
If True, returns a pandas Series with the mean for each day. If False, returns the mean for all days combined.
If True, returns a pandas Series with the mean for each day. If False, returns the mean for the entire dataset.
**kwargs : dict
Additional keyword arguments to be passed to the function. For more information view the documentation for
pandas.DataFrameGroupBy.mean() for per_day=True and pandas.DataFrame.mean() for per_day=False.
Expand Down Expand Up @@ -226,7 +226,7 @@ def std(self,
----------
per_day : bool, default False
If True, returns a pandas Series with the standard deviation for each day. If False, returns the
standard deviation for all days combined.
standard deviation for the entire dataset.
ddof : int, default 1
Delta Degrees of Freedom. The divisor used in calculations is N - ddof, where N represents the number of
elements. By default ddof is 1.
Expand Down Expand Up @@ -270,7 +270,7 @@ def cv(self,
----------
per_day : bool, default False
If True, returns the an array with the coefficient of variation for each day. If False, returns
the coefficient of variation for all days combined.
the coefficient of variation for the entire dataset.
ddof : int, default 1
Delta Degrees of Freedom. The divisor used in calculations is N - ddof, where N represents the number of
elements. By default ddof is 1.
Expand Down Expand Up @@ -314,7 +314,7 @@ def pcv(self,
----------
per_day : bool, default False
If True, returns the a pandas.Series with the percentage coefficient of variation for each day. If False,
returns the percentage coefficient of variation for all days combined.
returns the percentage coefficient of variation for the entire dataset.
ddof : int, default 1
Delta Degrees of Freedom. The divisor used in calculations is N - ddof, where N represents the number of
elements. By default ddof is 1.
Expand Down Expand Up @@ -419,7 +419,7 @@ def iqr(self,
----------
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 all days combined.
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. Default is 'linear'.
Expand Down Expand Up @@ -518,7 +518,7 @@ def tir(self,
Parameters
----------
per_day : bool, default False
If True, returns a pandas Series with the TIR for each day. If False, returns the TIR for all days combined.
If True, returns a pandas Series with the TIR for each day. If False, returns the TIR for the entire dataset.
interval : list of int|float, default [0,70,180]
Interval of glucose concentration to calculate :math:`\\tau`. Can be a list of 1 number, in that case the
time will be calculated below and above that number. It will always try to calculate the time below the first
Expand Down Expand Up @@ -594,7 +594,7 @@ def fd(self,
Parameters
----------
per_day : bool, default False
If True, returns a pandas Series with the FD for each day. If False, returns the FD for all days combined.
If True, returns a pandas Series with the FD for each day. If False, returns the FD for the entire dataset.
interval : list of int|float, default [0,70,180]
Interval of glucose concentration to calculate `FD`. Can be a list of 1 number, in that case the time will
be calculated below and above that number. It will always try to calculate the time below the first number
Expand Down Expand Up @@ -666,7 +666,7 @@ def auc(self,
Parameters
----------
per_day : bool, default False
If True, returns a pandas Series with the AUC for each day. If False, returns the AUC for all days combined.
If True, returns a pandas Series with the AUC for each day. If False, returns the AUC for the entire dataset.
time_unit : str, default 'm' (minutes)
The time unit for the x-axis. Can be 's (seconds)', 'm (minutes)', or 'h (hours)'.
threshold : int | float, default 0
Expand Down Expand Up @@ -740,7 +740,7 @@ def mage(self,
Parameters
----------
per_day : bool, default False
If True, returns a pandas Series with the MAGE for each day. If False, returns the MAGE for all days combined.
If True, returns a pandas Series with the MAGE for each day. If False, returns the MAGE for the entire dataset.
Returns
-------
Expand Down Expand Up @@ -796,7 +796,7 @@ def dt(self,
Parameters
----------
per_day : bool, default False
If True, returns a pandas Series with the DT for each day. If False, returns the DT for all days combined.
If True, returns a pandas Series with the DT for each day. If False, returns the DT for the entire dataset.
Returns
-------
Expand Down Expand Up @@ -862,7 +862,7 @@ def bgi(self,
Parameters
----------
per_day : bool, default False
If True, returns a pandas Series with the LBGI for each day. If False, returns the BGI for all days combined.
If True, returns a pandas Series with the LBGI for each day. If False, returns the BGI for the entire dataset.
index_type : str, default 'h'
Type of index to calculate. Can be 'h' (High Blood Glucose Index) or 'l' (Low Blood Glucose Index).
maximum : bool, default False
Expand Down Expand Up @@ -1190,7 +1190,7 @@ def conga(self,
Parameters
----------
per_day : bool, default False
If True, returns the CONGA for each day separately. If False, returns the CONGA for all days combined.
If True, returns the CONGA for each day separately. If False, returns the CONGA for the entire dataset.
m : int, default 1
Number of hours to use for the CONGA calculation.
slack : int, default 0
Expand Down Expand Up @@ -1289,7 +1289,7 @@ def mag(self,
Parameters
----------
per_day : bool, default False
If True, returns the an array with the MAG for each day. If False, returns the MAG for all days combined.
If True, returns the an array with the MAG for each day. If False, returns the MAG for the entire dataset.
time_unit : str, default 'm' (minutes)
The time time_unit for the x-axis. Can be 's (seconds)', 'm (minutes)', or 'h (hours)'.
Expand Down Expand Up @@ -1356,7 +1356,7 @@ def dfa(self,
Parameters
----------
per_day : bool, default False
If True, returns the an array with the DFA for each day. If False, returns the DFA for all days combined. If
If True, returns the an array with the DFA for each day. If False, returns the DFA for the entire dataset. If
a day has very few data points, the DFA for that day will be NaN.
Returns
Expand Down Expand Up @@ -1438,7 +1438,7 @@ def samp_en(self,
----------
per_day : bool, default False
If True, returns the an array with the Sample Entropy for each day. If False, returns the Sample Entropy for
all days combined.
the entire dataset.
Returns
-------
Expand Down Expand Up @@ -1504,7 +1504,7 @@ def mse(self,
----------
per_day : bool, default False
If True, returns the an array with the Multiscale Sample Entropy for each day. If False, returns the
Multiscale Sample Entropy for all days combined.
Multiscale Sample Entropy for the entire dataset.
Returns
-------
Expand Down
2 changes: 1 addition & 1 deletion glucopy/metrics/cv.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ def cv(df: pd.DataFrame,
:attr:`glucopy.Gframe.data`.
per_day : bool, default False
If True, returns the an array with the coefficient of variation for each day. If False, returns
the coefficient of variation for all days combined.
the coefficient of variation for the entire dataset.
ddof : int, default 1
Delta Degrees of Freedom. The divisor used in calculations is N - ddof, where N represents the number of
elements. By default ddof is 1.
Expand Down
2 changes: 1 addition & 1 deletion glucopy/metrics/iqr.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ def iqr(df: pd.DataFrame,
:attr:`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 all days combined.
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. Default is 'linear'.
Expand Down
2 changes: 1 addition & 1 deletion glucopy/metrics/mean.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ def mean(df : pd.DataFrame,
DataFrame containing the CGM values. The dataframe must contain 'CGM' and 'Day' columns present in
:attr:`glucopy.Gframe.data`.
per_day : bool, default False
If True, returns a pandas Series with the mean for each day. If False, returns the mean for all days combined.
If True, returns a pandas Series with the mean for each day. If False, returns the mean for the entire dataset.
**kwargs : dict
Additional keyword arguments to be passed to the function. For more information view the documentation for
pandas.DataFrameGroupBy.mean() for per_day=True and pandas.DataFrame.mean() for per_day=False.
Expand Down
2 changes: 1 addition & 1 deletion glucopy/metrics/std.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ def std(df: pd.DataFrame,
:attr:`glucopy.Gframe.data`.
per_day : bool, default False
If True, returns a pandas Series with the standard deviation for each day. If False, returns the
standard deviation for all days combined.
standard deviation for the entire dataset.
ddof : int, default 1
Delta Degrees of Freedom. The divisor used in calculations is N - ddof, where N represents the number of
elements. By default ddof is 1.
Expand Down
2 changes: 1 addition & 1 deletion glucopy/metrics/tir.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ def tir(df: pd.DataFrame,
Parameters
----------
per_day : bool, default False
If True, returns a pandas Series with the TIR for each day. If False, returns the TIR for all days combined.
If True, returns a pandas Series with the TIR for each day. If False, returns the TIR for the entire dataset.
interval : list of int|float, default [0,70,180]
Interval of glucose concentration to calculate :math:`\\tau`. Can be a list of 1 number, in that case the
time will be calculated below and above that number. It will always try to calculate the time below the first
Expand Down

0 comments on commit 3129180

Please sign in to comment.