ibrahim17t commited on
Commit
79ebd49
·
verified ·
1 Parent(s): 31ff3fa

Create README.md

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