docs: add warning about sample CGM data format limitations#81
Open
docs: add warning about sample CGM data format limitations#81
Conversation
Adds prominent warning cell explaining that the sample CGM data from PLOS Biology does not fully comply with IEEE 1752/OMH standards: - Units use MGDL instead of mg/dL - Modality incorrectly shows self-reported instead of sensed - Temporal relationship to meal uses invalid 'unknown' value - External datasheet lacks proper device provenance Addresses #60
for more information, see https://pre-commit.ci
This was referenced Dec 21, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Addresses part of #60 by adding a prominent warning to the CGM tutorial explaining that the sample data does not fully comply with IEEE 1752/Open mHealth standards.
Problem
The sample CGM data in the tutorial (sourced from PLOS Biology research) has several format issues:
MGDLinstead ofmg/dLself-reportedinstead ofsensed(CGM devices sense, not self-report)unknowninstead of OMH-compliant valuesThese issues could mislead users learning the OMH format or suggest that validation isn't properly enforced.
Changes
tutorial/tutorial-cgm.ipynb:
Related Issues
Testing
npm run myst -- build --htmllocallyNext Steps
A separate issue will be created in jupyterhealth-exchange requesting:
Generated with Claude Code
Co-Authored-By: Claude noreply@anthropic.com