Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

V2.0.0 #23

Merged
merged 60 commits into from
Nov 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
60 commits
Select commit Hold shift + click to select a range
5810986
feat: ✨ make version 2.0.0 as current
Aydawka Oct 21, 2024
2a38eb7
feat: ✨ move assets folder into the docs
Aydawka Oct 21, 2024
9f85256
fix: 🐛 made modifications
Aydawka Oct 21, 2024
a4046cd
fix: 🐛 move asssets and components to correct location
Aydawka Oct 21, 2024
70a3b70
fix: 🐛 links
Aydawka Oct 21, 2024
4e780d2
fix: 🐛 format and typo
Aydawka Oct 21, 2024
979ab91
fix: 🐛 broken links
Aydawka Oct 21, 2024
0e6d264
fix: 🐛 path issue
Aydawka Oct 21, 2024
661f153
fix: 🐛 restore path name
Aydawka Oct 21, 2024
ec66fd7
fix: 🐛 update healthsheet
Aydawka Oct 21, 2024
1c8b646
fix: 🐛 add static files to global static
Aydawka Oct 22, 2024
dd0aba2
fix: 🐛 remove unnecessary files
Aydawka Oct 22, 2024
dc3422a
fix: 🐛 update healthsheet
Aydawka Oct 22, 2024
8a45110
fix: 🐛 minor date
Aydawka Oct 22, 2024
229fe1f
fix: 🐛 minor links
Aydawka Oct 22, 2024
c81623f
fix: 🐛 remove json and v2 files from components and static
Aydawka Oct 22, 2024
b61aaff
fix: 🐛 relocate static files
Aydawka Oct 22, 2024
d09dbcf
fix: 🐛 remove version future
Aydawka Oct 23, 2024
0cefc9c
fix: 🐛 broken healthsheet files
Aydawka Oct 23, 2024
374e89f
chore: 🔨 lock docusaurus deps
megasanjay Oct 23, 2024
7a2df86
fix: 🐛 reswizzle version dropdown component
megasanjay Oct 23, 2024
e678ce6
fix: 🐛 move page feedback to client side
megasanjay Oct 23, 2024
c3049a4
fix: 🐛 move page feedback to client side
megasanjay Oct 23, 2024
3cb6b8e
fix: 🐛 move page feedback to client side
megasanjay Oct 23, 2024
21ca3fe
fix: 🐛 move page feedback to client side
megasanjay Oct 23, 2024
4c05402
fix: 🐛 remove page feedback
megasanjay Oct 23, 2024
2f10ce9
fix: 🐛 update changelog
Aydawka Oct 24, 2024
f47f111
fix: 🐛 typos
Aydawka Oct 24, 2024
c149629
fix: 🐛 change doi in the fair principles page
Aydawka Oct 24, 2024
bb584fb
fix: 🐛 change pdf name in questionnaries
Aydawka Oct 24, 2024
46124f5
chore: 🔨 update landing page details
Aydawka Oct 25, 2024
9712c69
chore: 🔨 update landing page details
Aydawka Oct 25, 2024
300d33d
fix: 🐛 link redirections
Aydawka Oct 25, 2024
9510c02
fix: 🐛 changelog headers
Aydawka Oct 25, 2024
f967a4d
fix: 🐛 modify cognition moCA table view
Aydawka Oct 25, 2024
69f57ec
fix: 🐛 modify hyperlink text in cognition moCA page
Aydawka Oct 28, 2024
ef53858
fix: 🐛 update doi in dataset distribution in healthsheet
Aydawka Oct 28, 2024
1e26841
fix: 🐛 CDS link
Aydawka Oct 28, 2024
bd9c048
fix: 🐛 CDS links
Aydawka Oct 29, 2024
f783164
feat: ✨ update version banner
megasanjay Oct 30, 2024
21bcee2
feat: ✨ update version banner
megasanjay Oct 30, 2024
2a37712
fix: 🐛 banner text
Aydawka Oct 30, 2024
a711488
chore: 🔨 update G30&G31 cells for the clinical data table
Aydawka Oct 30, 2024
6b4fb7c
chore: 🔨 update alcaline and nt-proBNP table
Aydawka Oct 30, 2024
071a8fb
chore: 🔨 update clinical table
Aydawka Oct 31, 2024
40a8155
chore: 🔨 update changelog
Aydawka Nov 4, 2024
d8ab925
chore: 🔨 update omop table
Aydawka Nov 5, 2024
217776e
fix: 🐛 update citation page
Aydawka Nov 5, 2024
842b081
style: 🎨 format
Aydawka Nov 6, 2024
af4d78e
chore: 🔨 update changelog
Aydawka Nov 6, 2024
9701a28
fix: 🐛 format of citation in training page
Aydawka Nov 7, 2024
960c496
fix: 🐛 column header
Aydawka Nov 7, 2024
87ebb3a
fix: 🐛 column header
Aydawka Nov 7, 2024
b54e257
fix: 🐛 citation format
Aydawka Nov 7, 2024
03540ed
fix: 🐛 changelog
Aydawka Nov 7, 2024
8504c9f
fix: 🐛 update landing page size and number of files
Aydawka Nov 7, 2024
11e0392
fix: 🐛 quotations
Aydawka Nov 7, 2024
5956090
fix: 🐛 citation
Aydawka Nov 7, 2024
2d165e2
fix: 🐛 update retinal photography page
Aydawka Nov 7, 2024
7af3246
fix: 🐛 landing page
Aydawka Nov 8, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions docs/AI-readiness/ethical-practices.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,3 @@ title: Ethical practices
---

The Bridge2AI program aspires to create four datasets that are ethically sourced. The Bridge2AI Center is working to define and characterize what “ethically source” means with respect to the use of machine learning and artificial intelligence technologies applied to health data. In the meantime, AI READI and other grand challenge programs apply accepted regulatory practices including, for example, the involvement of an institutional review board to evaluate compliance with human research protections. In addition, a license has been developed to state the terms of use for those accessing the data available to the public. For data that are deemed more sensitive, a data use agreement will be negotiated.

import PageFeedback from '@site/src/components/PageFeedback';

<PageFeedback />
10 changes: 3 additions & 7 deletions docs/AI-readiness/fair-principles.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ The [FAIR Principles](https://doi.org/10.1038/sdata.2016.18) published in 2016 a
</td>
<td className="align-top">
The AI-READI dataset is shared on fairhub.io, which provides a DOI for the dataset
([https://doi.org/10.60775/fairhub.1](https://doi.org/10.60775/fairhub.1))
([https://doi.org/10.60775/fairhub.2](https://doi.org/10.60775/fairhub.2))
</td>
</tr>
<tr>
Expand Down Expand Up @@ -228,7 +228,7 @@ The [FAIR Principles](https://doi.org/10.1038/sdata.2016.18) published in 2016 a
The AI-READI dataset includes a dataset_description.json metadata file as per the
CDS which has a field to include qualified reference to other (meta)data. More
details are provided in the
[CDS specification documentation](https://cds-specification.readthedocs.io/en/v0.1.0/).
[CDS specification documentation](https://cds-specification.readthedocs.io/en/v0.1.1/).
</td>
</tr>
<tr>
Expand Down Expand Up @@ -311,7 +311,7 @@ The [FAIR Principles](https://doi.org/10.1038/sdata.2016.18) published in 2016 a
<td className="align-top">
The AI-READI dataset is structured according to the CDS, which imposes a standard
folder structure, naming convention for directories, and metadata files that follow
community standards. More details are provided in the [CDS specification documentation](https://cds-specification.readthedocs.io/en/v0.1.0/).
community standards. More details are provided in the [CDS specification documentation](https://cds-specification.readthedocs.io/en/v0.1.1/).
<p>
All the data files in the AI-READI dataset are in format that meet domain-relevant
community standards (e.g., DICOM for images). This is described in detail in the
Expand All @@ -320,7 +320,3 @@ The [FAIR Principles](https://doi.org/10.1038/sdata.2016.18) published in 2016 a
</td>
</tr>
</table>

import PageFeedback from '@site/src/components/PageFeedback';

<PageFeedback />
4 changes: 0 additions & 4 deletions docs/about.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,3 @@ This documentation is associated with v1.0 of the dataset, which contains data f
- The `Dataset Documentation` section includes an overall description of the dataset using the Healthsheet template, and this section also provides details about each of the data domains included in the dataset. For each data domain, we have provided a general overview of the clinical context and how the data were acquired in the study, relevant individual variables, and data processing details including file formats, data standards, metadata, and example outputs.
- The `AI-readiness` section describes additional considerations that were integrated into the study design, including consideration of FAIR principles and Ethical practices.
- The [`Additional resources`](additional-resources) section provides a list of resources related to the dataset that could be useful for understanding and using the dataset.

import PageFeedback from '@site/src/components/PageFeedback';

<PageFeedback />
4 changes: 0 additions & 4 deletions docs/additional-resources.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,3 @@ We are pleased to present several abstracts concerning work from AI-READI at the
## Resources citing the dataset

We will add resources that cite the dataset as they become available.

import PageFeedback from '@site/src/components/PageFeedback';

<PageFeedback />
44 changes: 39 additions & 5 deletions docs/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,48 @@ title: Changelog

All notable changes to this documentation will be documented in this file.

The format is based on [Keep a Changelog v1.0.0](https://keepachangelog.com/en/1.0.0/).
## [2.0.0] - 2024-11-08

## 1.0.0 (2024-04-01)
### Identifier/Link

https://doi.org/10.60775/fairhub.2

### Added

- First version of the documentation associated with the AI-READI dataset v1.0
- Data from additional 863 participants has been added.
- OCT and OCTA scans from the Zeiss Cirrus device have been added.

### Changed

- v1.0.0 (pilot) data environmental sensor processing was performed manually. When upgrading to a consistent, automated process, the number of removed rows of data changed for 22 cases. More lines were removed in 18 cases comprising less than .1% of the data in each case. In 4 cases, up to 2% more rows were recovered and added to the dataset.
- Garmin:
- Sleep:
- We have applied a standardized extension to incorporate sleep stages (awake, light, rem, deep) in the data.
- We updated the calories data tag from “duration” to “calories_value”:
- `"calories_value": { "value": X, "unit": "kcal"}`
- Manifest [needs to be updated in the documentations/website]:
- The “physical_activity_num_records” field has been renamed to “physical_activity_num_days” and the values also update respectively.
- Values for the “sleep_record_count” field have been updated to reflect the number of individual sleep stage records instead of the number of days.
- Values for the “average_sleep_hours” field have been updated with respect to the following formula:
- average_sleep_duration = total_sleep_duration / number_of_records
- CGM: To ensure consistency in the body format across all wearable data files, we have updated the structure of the JSON files as follows:
- The "body" field now includes a section for continuous glucose monitoring (CGM) data:
- "body": `{ "cgm": [ ...list of observations ] }`
- Labs OMOP mapping table replaced with updated version
- 2 mapping rows updated (units changed to mg/DL for Urine creatinine and Urine Albumin)
- 9 mapping rows added to add UCUM codes for units
- MOCA OMOP mapping table replaced with updated version
- 7 mapping rows updated
- REDCap OMOP mapping table replaced with updated version
- 344 mapping rows updated
- “value_as_concept_id,” “qualifier_concept_id,” and “qualifier_source_value” columns added to mapping table

## [1.0.0] - 2024-05-03

import PageFeedback from '@site/src/components/PageFeedback';
### Identifier/Link

https://doi.org/10.60775/fairhub.1

### Added

<PageFeedback />
- Added data from pilot study (204 participants)
19 changes: 10 additions & 9 deletions docs/citation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,13 @@ title: Citation

As per the [license terms](preliminary/license), if you use the AI-READI dataset or any subset of it, you must cite the following references:

```
AI-READI Consortium. (2024). Flagship Dataset of Type 2 Diabetes from the
AI-READI Project (1.0.0) [Data set]. FAIRhub.
https://doi.org/10.60775/fairhub.1
```

import PageFeedback from '@site/src/components/PageFeedback';

<PageFeedback />
1. ```
AI-READI Consortium. (2024). "AI-READI: rethinking data collection, preparation and
sharing for propelling AI-based discoveries in diabetes research and beyond."
Nature metabolism. https://doi.org/10.1038/s42255-024-01165-x
```
2. ```
AI-READI Consortium. (2024). Flagship Dataset of Type 2 Diabetes from the
AI-READI Project (2.0.0) [Data set]. FAIRhub.
https://doi.org/10.60775/fairhub.2
```
4 changes: 0 additions & 4 deletions docs/dataset/cardiac-ecg/cardiac-ecg.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,3 @@ There is more than one protocol for obtaining and reporting ECG information. Thi

- [General information on the ECG protocols and reading an ECG](https://en.wikipedia.org/wiki/Electrocardiography)
- [Philips DXL ECG Algorithm Physician’s Guide](<https://www.documents.philips.com/doclib/enc/fetch/2000/4504/577242/577243/577246/581601/711562/DXL_ECG_Algorithm_Physician_s_Guide_(ENG)_Ed.2.pdf>) with information on the fields that are printed on an ECG report. Please note that while the guide offers insights into ECG interpretation, it does not replace medical expertise. Always consult with a physician for accurate diagnosis and treatment recommendations.

import PageFeedback from '@site/src/components/PageFeedback';

<PageFeedback />
Original file line number Diff line number Diff line change
Expand Up @@ -135,15 +135,10 @@ Resources to learn more about SSSOM:

### OMOP Mapping Table

import StructureTable from '@site/src/components/StructureTable';

<a href="/omopTable" target="_blank">See the table here</a>
<a href="/v2-omopTable" target="_blank">
See the table here
</a>

## Race, ethnicity, gender, and date/month of birth

Note that the fields for race, ethnicity, gender, and date/month of birth are all coded as '0' in the person.csv file because this information is omitted from the data. Birthday has to be released with birth year only per the HIPAA law for Safe Harbor. Additionally, we have decided to remove race, ethnicity, and gender information from this public set of the AI-READI dataset to prevent stigmatizing findings. More details are available in the [healthsheet](https://docs.aireadi.org/docs/1/dataset/healthsheet) regarding which variables were removed.

import PageFeedback from '@site/src/components/PageFeedback';

<PageFeedback />

Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,5 @@ import {Redirect} from '@docusaurus/router';
import DirectOmopTable from '@site/src/components/DirectOmopTable';


<!-- {/* <Redirect to="/omopTable"/>; */} -->
<DirectOmopTable />

Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
sidebar_position: 2
title: Clinical Lab Tests
---
import ClinicalLabTable from '@site/src/components/ClinicalLabTable';

## Overview of Data Domain

Expand All @@ -20,43 +19,69 @@ Clinical lab tests are a fundamental component of medical diagnostics and patien

## Variables included in Data Domain

<a href="/dataDomainTable" target="_blank">See the table here</a>
<a href="/v2-dataDomainTable" target="_blank">
See the table here
</a>

{/* <ClinicalLabTable /> */}

#### NT-proBNP Reference Intervals
| Age | Female Range | Male Range |
| ------ | --------------- | ------------------ |
| 0-2d | 321-11987 | 321-11987 |
| 3d-10d | 263-5918 | 263-5918 |
| 11d-1m | 263-5918 | 263-5918 |
| 2m-1y | 37-646 |37-646 |
| 2y | 39-413 | 39-413 |
| 3y-6y | 23-289 | 23-289 |
| 7y-14y | 0-157 |0-157 |
| 15y-18y | 0-158 | 0-158 |
| 19y-39y | 0-160| 0-79 |
| 40y-44y | 0-162 |0-72 |
| 45y-54y | 0-141 |0-87 |
| 55y-64y | 0-226 | 0-88 |
| 65y- | 0-540| 0-540 |

| Sex | Age_Low | Age_High | Range_Low | Range_High |
|-----|---------|----------|-----------|-------------|
| F | 0d | 2d | 321 | 11987 |
| F | 3d | 10d | 263 | 5918 |
| F | 11d | 1m | 263 | 5918 |
| F | 2m | 1y | 37 | 646 |
| F | 2y | 2y | 39 | 413 |
| F | 3y | 6y | 23 | 289 |
| F | 7y | 14y | 0 | 157 |
| F | 15y | 18y | 0 | 158 |
| F | 19y | 38y | 0 | 160 |
| F | 40y | 44y | 0 | 162 |
| F | 45y | 54y | 0 | 141 |
| F | 55y | 64y | 0 | 226 |
| F | 65y | 200y | 0 | 540 |
| M | 0d | 2d | 321 | 11987 |
| M | 3d | 10d | 263 | 5918 |
| M | 11d | 1m | 263 | 5918 |
| M | 2m | 1y | 37 | 646 |
| M | 2y | 2y | 39 | 413 |
| M | 3y | 6y | 23 | 289 |
| M | 7y | 14y | 0 | 157 |
| M | 15y | 18y | 0 | 158 |
| M | 19y | 38y | 0 | 79 |
| M | 40y | 44y | 0 | 72 |
| M | 45y | 54y | 0 | 87 |
| M | 55y | 64y | 0 | 88 |
| M | 65y | 200y | 0 | 540 |

#### Alkaline Phosphatase reference ranges
| Age | Female Range | Male Range |
| ------ | --------------- | ------------------ |
| 0-9y | 111-281 | 115-324|
| 10y-11y | 132-366 | 115-324|
| 12y-13y | 89-285 | 119-426|
| 14y-17y | 43-226 |72-400|
| 18y-24y | 26-98 | 42-136|
| 25y-34y | 25-100 | 35-109|
| 35y-44y |25-112 |36-122|
| 45y-54y | 34-121 | 39-139|
| 55y-64y | 31-132| 37-159|
| 65y-74y | 38-172 |36-161|
| 75y- |49-199 |52-227|

| Sex | Age_Low | Age_High | Range_Low | Range_High |
|-----|---------|----------|-----------|-------------|
| F | 0y | 9y | 111 | 281 |
| F | 10y | 11y | 132 | 366 |
| F | 12y | 13y | 89 | 285 |
| F | 14y | 17y | 43 | 226 |
| F | 18y | 24y | 26 | 98 |
| F | 25y | 34y | 25 | 100 |
| F | 35y | 44y | 25 | 112 |
| F | 45y | 54y | 34 | 121 |
| F | 55y | 64y | 31 | 132 |
| F | 65y | 74y | 38 | 172 |
| F | 75y | 200y | 49 | 199 |
| M | 0y | 9y | 115 | 324 |
| M | 10y | 11y | 115 | 324 |
| M | 12y | 13y | 119 | 426 |
| M | 14y | 17y | 72 | 400 |
| M | 18y | 24y | 42 | 136 |
| M | 25y | 34y | 35 | 109 |
| M | 35y | 44y | 36 | 122 |
| M | 45y | 54y | 39 | 139 |
| M | 55y | 64y | 37 | 159 |
| M | 65y | 74y | 36 | 161 |
| M | 75y | 200y | 52 | 227 |

## Data Processing

Expand Down Expand Up @@ -138,7 +163,3 @@ print(‘ Data saved to hba1c.csv')
| value_source_value | Source value for the measurement value | 65 | 5.7 |
| measurement_event_id | Unique identifier for the measurement event | 0 | 0 |
| meas_event_field_concept_id | Concept ID for the measurement event field | 0 | 0 |

import PageFeedback from '@site/src/components/PageFeedback';

<PageFeedback />
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
sidebar_position: 2
title: MoCA Table
---


import {Redirect} from '@docusaurus/router';
import DirectCognitionMoCA from '@site/src/components/DirectCognitionMoCA';

<DirectCognitionMoCA />

4 changes: 4 additions & 0 deletions docs/dataset/clinical-data/cognition-MoCA/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Cognition MoCA",
"position": 6
}
Loading
Loading