# List of functionalities of AGATA
This is a list of functionalities of AGATA ordered by topic.
# Analysis
Command to launch the AGATA GUI:
agata
.
# Analysis
List of functions that can be used to get an overall report/analysis of glucose profile/s:
analyzeGlucoseProfile
: function that computes the glycemic outcomes of a glucose profile;analyzeOneArm
: function that computes the glycemic outcomes of one arm;compareTwoArms
: function that compares the glycemic outcomes of two arms.
# Time
List of functions that can be used to compute time related glucose metrics:
timeInHypoglycemia
: function that computes the percentage of time spent in hypoglycemia.timeInL1Hypoglycemia
: function that computes the percentage of time spent in level 1 hypoglycemia.timeInL2Hypoglycemia
: function that computes the percentage of time spent in level 2 hypoglycemia.timeInHyperglycemia
: function that computes the percentage of time spent in hyperglycemia;timeInL1Hyperglycemia
: function that computes the percentage of time spent in level 1 hyperglycemia;timeInL2Hyperglycemia
: function that computes the percentage of time spent in level 2 hyperglycemia;timeInTarget
: function that computes the percentage of time spent in the target range;timeInTightTarget
: function that computes the percentage of time spent in the tight target range;timeInGivenRange
: function that computes the percentage of time spent in the given range.
# Variability
List of functions that can be used to compute variability related glucose metrics:
meanGlucose
: function that computes the mean glucose concentration;stdGlucose
: function that computes the standard deviation of the glucose concentration;cvGlucose
: function that computes the coefficient of variation of the glucose concentration;medianGlucose
: function that computes the median glucose concentration;rangeGlucose
: function that computes the range spanned by the glucose concentration;iqrGlucose
: function that computes the interquartile range of the glucose concentration;jIndex
: function that computes the J-Index of the glucose concentration;aucGlucose
: function that computes the area under the curve (AUC) of glucose concentration, i.e., the area between the glucose trace and zero. It assumes that the glucose value between two samples is constant;aucGlucoseOverBasal
: function that computes the area under the curve (AUC) of glucose concentration over a basal value. This means that glucose values above a given basal value will sum up positive AUC, while glucose values below the given basal value will sum up in negative AUC. It assumes that the glucose value between two samples is constant;gmi
: function that computes the glucose management indicator (GMI) of the given data;sddmIndex
: function that computes the standard deviation of within-day means index (SDDM);sdwIndex
: function that computes the mean of within-day standard deviation index (SDW);mageIndex
: function that computes the mean amplitude of glycemic excursion (MAGE) index;magePlusIndex
: function that computes the mean amplitude of positive glycemic excursion (MAGE+) index;mageMinusIndex
: function that computes the mean amplitude of negative glycemic excursion (MAGE-) index;efIndex
: function that computes the excursion frequency (EF) index, i.e., the number of excursion > 75;CVGA
: function that performs the control variablity grid analysis (CVGA);conga
: function that computes the Continuous Overall Net Glycemic Action (CONGA) index;modd
: function that computes the mean of daily difference (MODD) index;cogi
: function that computes the Continuous Glucose Monitoring Index (COGI);poincareGlucose
: function that fits an ellipse corresponding to the Poincare' plot of the(x,y) = (glucose(t-1),glucose(t))
graph;glucoseROC
: function that computes the glucose rate-of-change (ROC) trace. As defined in the given reference, ROC at time t is defined as the difference between the glucose at time t and t-15 minutes divided by 15 (ignores nan values). By definition, the first two samples are always nan;stdGlucoseROC
: function that computes the standard deviation of the glucose ROC (ignores nan values).
# Error metrics
List of functions that can be used to compute some error metric between two glucose profiles:
rmse
: function that computes the root mean squared error (RMSE) between two glucose traces;cod
: function that computes the coefficient of determination (COD) between two glucose traces;mard
: function that computes the mean absolute relative difference (MARD) between two glucose traces;clarke
: function that performs Clarke Error Grid Analysis (CEGA);timeDelay
: function that computes the time delay between two glucose traces. The time delay is computed as the time shift necessary to maximize the correlation between the two traces;gRMSE
: function that computes the glucose root mean squared error (gRMSE) between two glucose traces.
# Risk metrics
List of functions that can be used to compute risk glucose metrics:
lbgi
: function that computes the low blood glucose index (LBGI) of the glucose concentration;hbgi
: function that computes the high blood glucose index (HBGI) of the glucose concentration;bgri
: function that computes the blood glucose risk index (BRGI) of the glucose concentration;dynamicRisk
: function that computes the dynamic risk based on current glucose concentration and its rate-of-change;adrr
: function that computes the average daily risk range (ADRR) of the glucose concentration;gri
: function that computes the Glycemic Risk Index (GRI) proposed Klonoff et al.
# Glycemic transformation
List of functions that can be used to compute glucose metrics that uses transformations of the glucose scale:
hypoIndex
: function that computes the hypoglycemic index;hyperIndex
: function that computes the hyperglycemic index;igc
: function that computes the index of glycemic control (IGC);mrIndex
: function that computes the mr value;gradeScore
: function that computes the glycemic risk assessment diabetes equation score (GRADE);gradeEuScore
: function that computes the glycemic risk assessment diabetes equation score in the euglycemic range (GRADEeu);gradeHypoScore
: function that computes the glycemic risk assessment diabetes equation score in the hypoglycemic range (GRADEhypo);gradeHyperScore
: function that computes the glycemic risk assessment diabetes equation score in the hyperglycemic range (GRADEhyper).
# Processing
List of functions that can be used to process glucose profiles:
retimeGlucose
: function that retimes the given data timetable to a
new timetable with homogeneous timestep;imputeGlucose
: function that imputes missing glucose data using linear interpolation;detrendGlucose
: function that detrends glucose data. To do that, the function computes the slope of the immaginary line that "links" the first and last glucose datapoints in the timeseries, then it "flatten" the entire timeseries according to that slope.
# Inspection
List of functions that can be used to find particular events in a given glucose profile:
findNanIslands
: function that locates nan sequences in vectordata
, and classifies them based on their length;findHypoglycemicEvents
: function that finds the hypoglycemic events in a given glucose trace;findHypoglycemicEventsByLevel
: function that finds the hypoglycemic events in a given glucose trace classifying them by level, i.e., hypoglycemia, level 1 hypoglycemia, level 2 hypoglycemia;findHyperglycemicEvents
: function that finds the hyperglycemic events in a given glucose trace;findHyperglycemicEventsByLevel
: function that finds the hyperglycemic events in a given glucose trace classifying them by level, i.e., hyperglycemia, level 1 hyperglycemia, level 2 hyperglycemia;findExtendedHypoglycemicEvents
: function that finds the extended hypoglycemic events in a given glucose trace;missingGlucosePercentage
: function that computes the percentage of missing values in the given glucose trace;numberDaysOfObservation(data)
: function that computes the number of days of observation of the given glucose trace.
# Utilities
List of function utilities that can be used to facilitate the use of AGATA:
glucoseVectorToTimetable
: function that converts a vector containing glucose samples sampled on an homogeneous timegrid with fixed timestep in a timetable;timetableToGlucoseVector
: function that converts a timetable with columnTime
andglucose
containing the glucose data, in a double vector containing the glucose data in theglucose
column;glucoseTimeVectorsToTimetable
: function that converts the two given vectors containing the glucose samples and the corresponding timestamps, respectively, in a timetable;timetableToGlucoseTimeVectors
: function that converts a timetable with columnTime
andglucose
containing the timestamps and the respective glucose data, in two vectors: one containing the timestamp data in theTime
column and the other containing the glucose data in theglucose
column;toMGDL
: function that converts a timetable with columnTime
andglucose
containing the timestamps and the respective glucose data in mmol/l to mg/dl;toMMOLL
: function that converts a timetable with columnTime
andglucose
containing the timestamps and the respective glucose data in mg/dL to mmol/;readFreestyleLibreData
: function that reads data from a .xlsx file downloaded from the Freestyle Libre CGM system and converts it in a timetable compatible with AGATA;readEversenseData
: function that reads data from a .xlsx file downloaded from the Eversense CGM system and converts it in a timetable compatible with AGATA;readDexcomData
: function that reads data from a .xlsx file downloaded from the Dexcom CGM system and converts it in a timetable compatible with AGATA.
# Visualization
List of functions that can be used to visualize glucose data:
plotGlucose
: function that visualizes the given glucose profile;plotGlucoseAsOneDay
: function that generates a plot of data in a single plot where each daily glucose profile is overlapped to each other;plotGlucoseAsOneDayComparison
: function that generates a plot of two glucose profiles in a single plot where each daily glucose profile is overlapped to each other;plotGlucoseArmAsOneDay
: function that generates a plot of an arm in a single plot where each daily profile is overlapped to each other;plotGlucoseArmAsOneDayComparison
: function that generates a plot of two arms in a single plot where each arm's daily profile is overlapped to each other. This is for comparison;generateAGP
: function that generates the ambulatory glucose profile (AGP) reports of the given data. A report is generated every 14 days of recordings starting backwards from last 14 days;plotCVGA
: function that plots the control variablity grid analysis (CVGA);plotCVGAComparison
: function that plots and visually compares the control variablity grid analysis (CVGA) of two arms;plotGRI
: function that plots the GRI grid;plotGRIComparison
: function that plots and visually compares the GRI grid of two arms;plotGlucoseROC
: function that visualizes the glucose ROC of the given data;histGlucoseROC
: function that visualizes the histogram of the glucose ROC of the given data;plotAggregatedGlucose
: function that visualizes the given data with superimposed aggregated glucose values;plotPoincareGlucose
: function that generates the Poincare' plot of the(x,y) = (glucose(t-1),glucose(t))
graph;plotPoincareGlucoseComparison
: function that generates and compares the Poincare' plot of the(x,y) = (glucose(t-1),glucose(t))
graphs of two CGM profiles;plotClarkeErrorGrid
: function that plots the Clarke Error Grid.