jackmanners/GSS-15

Good Sleeper Scale-15 scoring guide and codes

The Good Sleeper Scale-15 items: a questionnaire for the standardised assessment of good sleepers

Manners, J., Appleton, S. L., Reynolds, A. C., Melaku, Y. A., Gill, T. K., Lovato, N., Sweetman, A., Bickley, K., Adams, R., Lack, L., and Scott, H.

This repository contains scoring codes for the Good Sleeper Scale-15 items. This is currently only implemented in Python and Excel, though an R version will be created if there is interest.

The manuscript can be found at doi.org/10.1111/jsr.13717.
The open-source questionnaire and scoring guide can be found on osf.io/na6jt.

Scoring

EXCEL: GSS15 - Excel Calculator.xlsx is likely the simplest use case for auto-scoring.
Please refer to the DATA FORMATTING section below, or the example data included in the .csv and .xlsx files to ensure compatability.

PYTHON: Navigate to the USAGE section below for instructions on how to score data using Python. python_scoring/gss.py should offer insight into how to automate scoring in other languages. Scoring is divided into sub-domains for ease of reading, but I'd hardly call anything I write especially Pythonic so apologies for that.

---

Python Requirements

Requirements can be found in requirements.txt, but main packages used are:

• Python 3
• pandas
• sv-ttk

If you have python installed already, run install_requirements.sh or with the below code to create a virtual environment and install required packages.

pip install -r requirements.txt

Tkinter GUI uses the Azure theme for ttk.

Usage

Scripts and tkinter GUI has been included to simplify usage. If you wish to omit the GUI or implement yourself, the scoring code for GSS-15 can be found in python_scoring/gss.py.

Run using the included run.sh or with the below.

python python_scoring/python_main.py

If you have not already, select Create Template to create a template csv file to input your data and fill this in with your exported data. The expected format can be found in the section below.

Scoring

Once you have filled in the data.csv template, attach this using Select Datafile. The window will promptly close and your scored data should be in the same file. New columns will have been added to represent the subdomain and total scores.

Data Formatting

participant_id	question_1	question_2	question_3	question_4	question_5	question_6	question_7	question_8	question_9	question_10	question_11	question_12	question_13	question_14	question_15
Input Guide	0-2	24H Time (HH:MM)	24H Time (HH:MM)	Hours (HH:MM)	24H Time (HH:MM)	24H Time (HH:MM)	Hours (HH:MM)	0-5	0-3	0-4	0-3	0-3	0-3	0-3	0-3
exampleid001	2	21:00	7:00	9:00	22:00	8:00	8:00	1	0	3	0	0	0	0	0

Where values are integers (e.g., 0-2), it is expected that these coincide with the order of responses in the GSS-15 from top to bottom or left to right.

# For example for question 1 ("Do you think you have a sleep problem?"):
- Yes = 0
- No = 1
- Maybe = 2

# Or question 10 ("In general, how often do you get enough sleep to feel your best the next day?"):
- Never = 0
- Rarely = 1
- Sometimes = 2
- Often = 3
- Always = 4

Licence

All source code is made available under a BSD 3-clause license. You may freely use and modify this code, without warranty, so long as you provide attribution to the authors. The manuscript text is not open source. The article's content has been published in the Journal of Sleep Research.

Citation

Manners, J., Appleton, S. L., Reynolds, A. C., Melaku, Y. A., Gill, T. K., Lovato, N., Sweetman, A., Bickley, K., Adams, R., Lack, L., & Scott, H. (2022). The Good Sleeper Scale-15 items: a questionnaire for the standardised assessment of good sleepers. Journal of Sleep Research, e13717. https://doi.org/10.1111/jsr.13717