Create README.md
Browse files
README.md
ADDED
|
@@ -0,0 +1,72 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
## Project Info
|
| 2 |
+
|
| 3 |
+
This is a data repository containing IEEG recording collected by the team at University of Texas Medical Branch. You can access its data directly from Epoch R package.
|
| 4 |
+
|
| 5 |
+
This data was migrated from OSF: https://osf.io/zwuyt/overview
|
| 6 |
+
|
| 7 |
+
|
| 8 |
+
|
| 9 |
+
## Description
|
| 10 |
+
|
| 11 |
+
This project contains de-identified patient data obtained during the surgical treatment of drug-resistant
|
| 12 |
+
epilepsy at the Hospital of the University of Pennsylvania. (Philadelphia,PA 19104)
|
| 13 |
+
from the public "HUP iEEG dataset" on
|
| 14 |
+
<a href="https://openneuro.org/datasets/ds004100/versions/1.1.3" style="color:blue; text-decoration:none;"> Openneuro data set link</a>.
|
| 15 |
+
The openneuro data set is in the BIDS format and was release as part of the manuscript
|
| 16 |
+
<a href="https://academic.oup.com/brain/article/146/6/2248/6979879" style="color:blue; text-decoration:none;"> Bernabei & Li et al.</a>.
|
| 17 |
+
We have curated ictal data of fiften patients out of the 58 subjects from the data.
|
| 18 |
+
Data cleaning was performed through RAVE (Reproducible Analysis & Visualization of iEEG), an open-source, NIH-funded software
|
| 19 |
+
built in R. The imported data was Notch filtered for contamination identified upon visual inspection, commonly on harmonics
|
| 20 |
+
of 60 Hz (60, 120, 180, etc.), with cutoff windows of 1, 2, and 2 Hz, respectively. If not already excluded during data import,
|
| 21 |
+
faulty channels were removed by visual inspection, including those that were clinically determined to be excessively noisy,
|
| 22 |
+
those recording from white matter, and other non-EEG electrodes (e.g., EKG).
|
| 23 |
+
After this is performed, a common average
|
| 24 |
+
reference across the remaining electrodes was used to remove any correlated noise. The data was clipped [-30s:30s] around seizure start.
|
| 25 |
+
The data contains the iEEG recordings, electrode information as row metadata (e.g., name, quality, labeled as in the seizure onset zone (SOZ)
|
| 26 |
+
or not, labeled as in the resection area or not), and patient metadata (e.g., gender, surgical outcome, brain region hypothesis,
|
| 27 |
+
age at first seizure, age at iEEG epilepsy surgery evaluation, type of electrodes (ECOG and SEEG)) as the table metadata.
|
| 28 |
+
|
| 29 |
+
## File Naming Convention
|
| 30 |
+
|
| 31 |
+
Output files are named using:
|
| 32 |
+
|
| 33 |
+
```text
|
| 34 |
+
frag_{site}_{subject}_run{run}.rds
|
| 35 |
+
```
|
| 36 |
+
|
| 37 |
+
where `site` denotes short form of data source, `subject` denotes the standardized subject identifier, & `run` denotes the corresponding ictal run number. For example:
|
| 38 |
+
|
| 39 |
+
`frag_upenn_sub064_run1.rds`
|
| 40 |
+
`frag_upenn_sub070_run2.rds`
|
| 41 |
+
|
| 42 |
+
## Row Metadata
|
| 43 |
+
|
| 44 |
+
The following row-level fields are present in `rowData` for each channel/contact:
|
| 45 |
+
|
| 46 |
+
- `name`: Channel/electrode label (string).
|
| 47 |
+
- `soz`: True if the channel is part of the seizure onset zone; false otherwise (logical).
|
| 48 |
+
- `soz_raw`: True if the channel is part of the seizure onset zone; false otherwise (logical). **_NOTE:_** `soz` & `soz_raw` will be same if there is no 'soz_corrected' version available. If `soz_corrected` version available in the source file, then `soz` will be the corrected final version while `soz_raw` keep the raw version.
|
| 49 |
+
- `resected`: True if the channel/electrode was resected during surgery; FALSE otherwise. (logical).
|
| 50 |
+
|
| 51 |
+
## Object Metadata
|
| 52 |
+
|
| 53 |
+
The following fields are present in `metaData` for each object: (total = 18)
|
| 54 |
+
|
| 55 |
+
- `patient`: Standardized Patient identifier (string).
|
| 56 |
+
- `originalPatientID`: Non-standardized or source file patient identifier (string).
|
| 57 |
+
- `source`: Data source or acquisition origin label as University of Pennsylvania (string).
|
| 58 |
+
- `type`: Recording type (string).
|
| 59 |
+
- `timeWindow`: Epoch time window as c(start, end) in seconds (numeric vector, length 2).
|
| 60 |
+
- `seizureTime`: Scalar onset time within the epoch window (seconds); typically 0.
|
| 61 |
+
- `totalRuns`: Total number of runs/segments available for this object (integer).
|
| 62 |
+
- `run`: Index of the current run/segment (integer).
|
| 63 |
+
- `gender`: Patient gender. Possible values: "F", "M" (string).
|
| 64 |
+
- `outcome`: Surgical outcome classification. Possible values: "S", "F" (string).
|
| 65 |
+
- `ageOnsetEpilepsy`: Age at epilepsy onset, in years (numeric).
|
| 66 |
+
- `ageIEEGSurgeryEvaluation`: Age at iEEG surgical evaluation, in years (numeric).
|
| 67 |
+
- `imagingOutcome`: Imaging findings summary (string).
|
| 68 |
+
- `brainRegion`: Primary implicated brain region(s) (string).
|
| 69 |
+
- `engel`: Engel categorization (string).
|
| 70 |
+
- `race`: Race (caucasian, african american, hispanic, asian) (string).
|
| 71 |
+
- `handedness`: L/R handedness (string).
|
| 72 |
+
- `surgeryType`: Surgery type (string).
|