Skip to content

Commit 57a92f7

Browse files
committed
CGM input files examples
1 parent ed14329 commit 57a92f7

6 files changed

Lines changed: 2710 additions & 17 deletions

File tree

README.md

Lines changed: 27 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,27 @@ A significant focus of this project has been ensuring compatibility with the ori
1818

1919
This approach ensures that the Python implementation produces results consistent with the original R package.
2020

21-
## Unit Test Status
21+
### Input & Output
22+
The implementation maintains compatibility with the R version while following Python best practices. The metrics can be used as:
23+
24+
```Python
25+
import iglu_python ias iglu
26+
27+
# With DataFrame input
28+
result_df = iglu.cv_glu(data) # data should have 'id', 'time', and 'gl' columns
29+
# Return DataFrame with "id' and column(s) with value(s)
30+
31+
# With Series input (some metrics require Series with DateTimeIndex)
32+
result_float = iglu.cv_glu(glucose_series) # just glucose values
33+
# returns a single float value
34+
35+
# Same with function that support list or ndarray
36+
result_float = iglu.cv_glu(glucose_list) # list of glucose values
37+
# returns a single float value
38+
39+
```
40+
41+
## IGLU-R Compatibility Test Status
2242
The current version of IGLU-PYTHON is test-compatible with IGLU-R v4.2.2
2343

2444
Unless noted, IGLU-R test compatability is considered successful if it achieves precision of 0.001
@@ -69,25 +89,15 @@ Unless noted, IGLU-R test compatability is considered successful if it achieves
6989
| process_data | Data Pre-Processor ||
7090
| CGMS2DayByDay |Interpolate glucose input||
7191

72-
### Input & Output
73-
The implementation maintains compatibility with the R version while following Python best practices. The metrics can be used as:
74-
75-
```Python
76-
import iglu_python ias iglu
77-
78-
# With DataFrame input
79-
result_df = iglu.cv_glu(data) # data should have 'id', 'time', and 'gl' columns
80-
# Return DataFrame with "id' and column(s) with value(s)
92+
## Extended functionality
93+
IGLU_PYTHON extends beyond the capabilities of the original IGLU-R package by offering enhanced functionality and improved user experience. We believe that combining these extended features with the proven reliability of IGLU-R creates a powerful synergy that benefits both the research community and wide software developers community.
8194

82-
# With Series input (some metrics require Series with DateTimeIndex)
83-
result_float = iglu.cv_glu(glucose_series) # just glucose values
84-
# returns a single float value
8595

86-
# Same with function that support list or ndarray
87-
result_float = iglu.cv_glu(glucose_list) # list of glucose values
88-
# returns a single float value
8996

90-
```
97+
| Function | Description |
98+
|-------------------|------------------------------------------|
99+
| load_libre() | Load Timeseries from Libre device file (CGM reading converted into mg/dL)
100+
| load_dexcom() | Load Timeseries from Dexcom device file (CGM reading converted into mg/dL)
91101

92102
# Installation
93103

tests/data/dexcom_eur_01.xlsx

139 KB
Binary file not shown.

tests/data/dexcom_eur_02.xlsx

141 KB
Binary file not shown.

tests/data/dexcom_eur_03.xlsx

135 KB
Binary file not shown.

0 commit comments

Comments
 (0)