sleep_health¶
Module that provides classes to access sleep health datasets. For details please read https://www.nature.com/articles/s41597-020-00753-2
Datasets Included in this module
- One Time Questionnaires:
Onboarding Demographics
About Me
My Family
My Health
Research Interest
Sleep Assessment
Sleep Habits
- Recurrent Questionnaires:
Nap Tracker
AM Check-in
PM Check-in
Sleep Quality Checker
Sleepiness Checker
Alertness Checker - Psychomotor Vigilance Task
- Wearable Data:
HealthKit Data
-
class
tasrif.data_readers.sleep_health.SleepHealthDataset(file_name, table_name)¶ Base class for all Sleep fitbit datasets
-
__init__(file_name, table_name)¶ Initializes a dataset reader with the input parameters.
- Parameters
file_name (str) – Path to the withings export file containing data.
table_name (str) – The table to extract data from.
-
process(*data_frames)¶ Function that runs validation hooks and processes the input data_frames.
- Parameters
*data_frames (list of pd.DataFrame) – Variable number of pandas dataframes to be processed
- Returns
Output of _process method
-