Skip to content

Commit 111b0b4

Browse files
authored
Update src_README.md
1 parent e24b3bf commit 111b0b4

File tree

1 file changed

+11
-19
lines changed

1 file changed

+11
-19
lines changed

src/src_README.md

+11-19
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,17 @@
1-
# SSRC_SleepStatistics - Documentation and Code for generating Sleep statistics used at the Surrey Sleep Research Centre
1+
# SSRC_InterscorerDifferenceGenerator - Example Code for creating the interscorer difference in sleep profile or hypnogram created by two Scorers
22

33
**Licence:**
4-
SSRC_SleepStatistics Copyright (C) 2024 Kiran K G Ravindran and contributors. Refer to the License.txt for more details.
4+
SSRC_InterscorerDifferenceGenerator Copyright (C) 2024 Kiran K G Ravindran. Refer to the License.txt for more details.
55

66
## File list and overview : Total 2 files
7-
1. "Example_code.m"
8-
Allow the import of the example data (Hypnograms and Markers); Generate the sleep statistics for all files and export the data table as a spreadsheet
9-
#### Embedded Support functions
10-
* Get_Markers - Outputs the Marker Info given Marker file path. Marker file format has to match the format in the example data
11-
12-
* Get_Hypnogram - Outputs the Hypnogram timevector and sleep stages given Hypnogram file path. Hypnogram file format has to match the format in the example data
13-
14-
* Get_SM_row - Format the out put of the Get_SSRC_SleepStatistics function into a table row
15-
16-
2. "Get_SSRC_SleepStatistics.m"
17-
18-
Type 0 - Standard function that generate all the statistics in the "Polysomnography Data Extraction and Analysis Specification" including the hourly estimates
19-
Type 1 - Reduced function - Does not generate hourly estimates - works for shorter Hypnograms
20-
21-
3. "RunLength" - Support function used for estimation run lengths of sleep stage segments. REF: Jan (2024). RunLength (https://www.mathworks.com/matlabcentral/fileexchange/41813-runlength), MATLAB Central File Exchange. Retrieved June 1, 2024.
22-
7+
1. "SSRC_InterscorerDifferenceGenerator.m"
8+
The code generates interscorer difference given Domino Marker files of the sleep recordings and Sleep profile exports from two sleep experts.
9+
a) Label_Marker_ID function gets the marker and hypnogram and output the curated data for use in the interscorer differences.
10+
11+
3. Output_example folder
12+
* Interscorer_agreement_001 - Contains the interscorer difference of sleep profile or hypnogram 001
13+
* Interscorer_agreement_all - Percentage of interscorer difference estimated for all sleep profile or hypnogram present in the input data folder
14+
2315
## Citation
24-
Refer the main page of the SSRC_SleepStatistics Repository
16+
Refer the main page of the SSRC_InterscorerDifferenceGenerator Repository
2517

0 commit comments

Comments
 (0)