2021-03-14 06:09:08 +01:00
########################################################################################################################
# GLOBAL CONFIGURATION #
########################################################################################################################
2020-10-19 23:13:10 +02:00
2020-12-15 04:15:39 +01:00
# See https://www.rapids.science/latest/setup/configuration/#participant-files
2021-04-15 02:52:45 +02:00
PIDS : [ android, ios, fitbit, empatica, empty]
2020-10-19 23:13:10 +02:00
2020-12-15 04:15:39 +01:00
# See https://www.rapids.science/latest/setup/configuration/#automatic-creation-of-participant-files
CREATE_PARTICIPANT_FILES :
2021-03-14 06:09:08 +01:00
CSV_FILE_PATH : "data/external/example_participants.csv" # see docs for required format
2020-10-21 22:46:40 +02:00
PHONE_SECTION :
2021-03-14 06:09:08 +01:00
ADD : True
2020-12-15 04:15:39 +01:00
DEVICE_ID_COLUMN : device_id # column name
2020-10-21 22:46:40 +02:00
IGNORED_DEVICE_IDS : [ ]
FITBIT_SECTION :
2021-03-14 06:09:08 +01:00
ADD : True
DEVICE_ID_COLUMN : fitbit_id # column name
IGNORED_DEVICE_IDS : [ ]
EMPATICA_SECTION :
ADD : True
DEVICE_ID_COLUMN : empatica_id # column name
2020-12-15 04:15:39 +01:00
IGNORED_DEVICE_IDS : [ ]
# See https://www.rapids.science/latest/setup/configuration/#time-segments
TIME_SEGMENTS : &time_segments
TYPE : PERIODIC # FREQUENCY, PERIODIC, EVENT
2021-04-15 02:52:45 +02:00
FILE : "tests/data/external/timesegments_periodic.csv"
2020-12-15 04:15:39 +01:00
INCLUDE_PAST_PERIODIC_SEGMENTS : FALSE # Only relevant if TYPE=PERIODIC, see docs
2021-03-14 06:09:08 +01:00
# See https://www.rapids.science/latest/setup/configuration/#timezone-of-your-study
TIMEZONE :
TYPE : SINGLE
SINGLE :
TZCODE : America/New_York
MULTIPLE :
TZCODES_FILE : data/external/multiple_timezones_example.csv
IF_MISSING_TZCODE : STOP
DEFAULT_TZCODE : America/New_York
FITBIT :
ALLOW_MULTIPLE_TZ_PER_DEVICE : False
INFER_FROM_SMARTPHONE_TZ : False
2020-12-15 04:15:39 +01:00
########################################################################################################################
# PHONE #
########################################################################################################################
2021-03-15 00:52:14 +01:00
# See https://www.rapids.science/latest/setup/configuration/#data-stream-configuration
2021-03-14 06:09:08 +01:00
PHONE_DATA_STREAMS :
USE : aware_csv
# AVAILABLE:
aware_mysql :
DATABASE_GROUP : MY_GROUP
aware_csv :
FOLDER : tests/data/external/aware_csv
2021-03-15 00:52:14 +01:00
aware_influxdb :
DATABASE_GROUP : MY_GROUP
2020-12-15 04:15:39 +01:00
# Sensors ------
# https://www.rapids.science/latest/features/phone-accelerometer/
PHONE_ACCELEROMETER :
2021-08-04 02:00:51 +02:00
CONTAINER : phone_accelerometer_raw.csv
2020-12-15 04:15:39 +01:00
PROVIDERS :
RAPIDS :
2021-08-04 02:00:51 +02:00
COMPUTE : True
2020-12-15 04:15:39 +01:00
FEATURES : [ "maxmagnitude" , "minmagnitude" , "avgmagnitude" , "medianmagnitude" , "stdmagnitude" ]
2021-03-15 00:52:14 +01:00
SRC_SCRIPT : src/features/phone_accelerometer/rapids/main.py
2020-12-15 04:15:39 +01:00
PANDA :
2021-08-04 02:00:51 +02:00
COMPUTE : True
2020-12-15 04:15:39 +01:00
VALID_SENSED_MINUTES : False
FEATURES :
exertional_activity_episode : [ "sumduration" , "maxduration" , "minduration" , "avgduration" , "medianduration" , "stdduration" ]
nonexertional_activity_episode : [ "sumduration" , "maxduration" , "minduration" , "avgduration" , "medianduration" , "stdduration" ]
2021-03-15 00:52:14 +01:00
SRC_SCRIPT : src/features/phone_accelerometer/panda/main.py
2020-12-15 04:15:39 +01:00
# See https://www.rapids.science/latest/features/phone-activity-recognition/
PHONE_ACTIVITY_RECOGNITION :
2021-03-13 00:14:49 +01:00
CONTAINER :
2021-06-24 01:08:14 +02:00
ANDROID : plugin_google_activity_recognition_raw.csv
IOS : plugin_ios_activity_recognition_raw.csv
2021-03-14 06:09:08 +01:00
EPISODE_THRESHOLD_BETWEEN_ROWS : 5 # minutes. Max time difference for two consecutive rows to be considered within the same AR episode.
2020-12-15 04:15:39 +01:00
PROVIDERS :
RAPIDS :
2021-06-24 01:08:14 +02:00
COMPUTE : True
2020-12-15 04:15:39 +01:00
FEATURES : [ "count" , "mostcommonactivity" , "countuniqueactivities" , "durationstationary" , "durationmobile" , "durationvehicle" ]
ACTIVITY_CLASSES :
STATIONARY : [ "still" , "tilting" ]
MOBILE : [ "on_foot" , "walking" , "running" , "on_bicycle" ]
VEHICLE : [ "in_vehicle" ]
2021-03-15 00:52:14 +01:00
SRC_SCRIPT : src/features/phone_activity_recognition/rapids/main.py
2020-12-15 04:15:39 +01:00
2021-01-14 21:24:55 +01:00
# See https://www.rapids.science/latest/features/phone-applications-crashes/
PHONE_APPLICATIONS_CRASHES :
2021-03-13 00:14:49 +01:00
CONTAINER : applications_crashes
2021-01-14 21:24:55 +01:00
APPLICATION_CATEGORIES :
CATALOGUE_SOURCE : FILE # FILE (genres are read from CATALOGUE_FILE) or GOOGLE (genres are scrapped from the Play Store)
CATALOGUE_FILE : "data/external/stachl_application_genre_catalogue.csv"
UPDATE_CATALOGUE_FILE : False # if CATALOGUE_SOURCE is equal to FILE, whether or not to update CATALOGUE_FILE, if CATALOGUE_SOURCE is equal to GOOGLE all scraped genres will be saved to CATALOGUE_FILE
SCRAPE_MISSING_CATEGORIES : False # whether or not to scrape missing genres, only effective if CATALOGUE_SOURCE is equal to FILE. If CATALOGUE_SOURCE is equal to GOOGLE, all genres are scraped anyway
PROVIDERS : # None implemented yet but this sensor can be used in PHONE_DATA_YIELD
2020-12-15 04:15:39 +01:00
# See https://www.rapids.science/latest/features/phone-applications-foreground/
PHONE_APPLICATIONS_FOREGROUND :
2021-04-13 22:45:32 +02:00
CONTAINER : phone_applications_foreground_raw.csv
2020-12-15 04:15:39 +01:00
APPLICATION_CATEGORIES :
CATALOGUE_SOURCE : FILE # FILE (genres are read from CATALOGUE_FILE) or GOOGLE (genres are scrapped from the Play Store)
CATALOGUE_FILE : "data/external/stachl_application_genre_catalogue.csv"
UPDATE_CATALOGUE_FILE : False # if CATALOGUE_SOURCE is equal to FILE, whether or not to update CATALOGUE_FILE, if CATALOGUE_SOURCE is equal to GOOGLE all scraped genres will be saved to CATALOGUE_FILE
SCRAPE_MISSING_CATEGORIES : False # whether or not to scrape missing genres, only effective if CATALOGUE_SOURCE is equal to FILE. If CATALOGUE_SOURCE is equal to GOOGLE, all genres are scraped anyway
PROVIDERS :
RAPIDS :
2021-04-13 22:45:32 +02:00
COMPUTE : True
INCLUDE_EPISODE_FEATURES : True
2020-12-15 04:15:39 +01:00
SINGLE_CATEGORIES : [ "all" , "email" ]
MULTIPLE_CATEGORIES :
social : [ "socialnetworks" , "socialmediatools" ]
2021-03-14 06:09:08 +01:00
entertainment : [ "entertainment" , "gamingknowledge" , "gamingcasual" , "gamingadventure" , "gamingstrategy" , "gamingtoolscommunity" , "gamingroleplaying" , "gamingaction" , "gaminglogic" , "gamingsports" , "gamingsimulation" ]
2021-07-01 22:25:38 +02:00
CUSTOM_CATEGORIES :
social_media : [ 'com.google.android.youtube' , 'com.snapchat.android' , 'com.instagram.android' , 'com.zhiliaoapp.musically' , 'com.facebook.katana' ]
dating : [ 'com.tinder' , 'com.relance.happycouple' , 'com.kiwi.joyride' ]
2021-03-14 06:09:08 +01:00
SINGLE_APPS : [ "top1global" , "com.facebook.moments" , "com.google.android.youtube" , "com.twitter.android" ] # There's no entropy for single apps
EXCLUDED_CATEGORIES : [ ]
2020-12-15 04:15:39 +01:00
EXCLUDED_APPS : [ "com.fitbit.FitbitMobile" , "com.aware.plugin.upmc.cancer" ]
2021-04-13 22:45:32 +02:00
FEATURES :
2021-07-01 22:25:38 +02:00
APP_EVENTS : [ "countevent" , "timeoffirstuse" , "timeoflastuse" , "frequencyentropy" ]
APP_EPISODES : [ "countepisode" , "minduration" , "maxduration" , "meanduration" , "sumduration" ]
2021-04-13 22:45:32 +02:00
IGNORE_EPISODES_SHORTER_THAN : 0 # in minutes, set to 0 to disable
IGNORE_EPISODES_LONGER_THAN : 300 # in minutes, set to 0 to disable
2021-03-15 00:52:14 +01:00
SRC_SCRIPT : src/features/phone_applications_foreground/rapids/main.py
2020-12-15 04:15:39 +01:00
2021-01-14 21:24:55 +01:00
# See https://www.rapids.science/latest/features/phone-applications-notifications/
PHONE_APPLICATIONS_NOTIFICATIONS :
2021-03-13 00:14:49 +01:00
CONTAINER : applications_notifications
2021-01-14 21:24:55 +01:00
APPLICATION_CATEGORIES :
CATALOGUE_SOURCE : FILE # FILE (genres are read from CATALOGUE_FILE) or GOOGLE (genres are scrapped from the Play Store)
CATALOGUE_FILE : "data/external/stachl_application_genre_catalogue.csv"
UPDATE_CATALOGUE_FILE : False # if CATALOGUE_SOURCE is equal to FILE, whether or not to update CATALOGUE_FILE, if CATALOGUE_SOURCE is equal to GOOGLE all scraped genres will be saved to CATALOGUE_FILE
SCRAPE_MISSING_CATEGORIES : False # whether or not to scrape missing genres, only effective if CATALOGUE_SOURCE is equal to FILE. If CATALOGUE_SOURCE is equal to GOOGLE, all genres are scraped anyway
PROVIDERS : # None implemented yet but this sensor can be used in PHONE_DATA_YIELD
2020-12-15 04:15:39 +01:00
# See https://www.rapids.science/latest/features/phone-battery/
PHONE_BATTERY :
2021-03-14 06:09:08 +01:00
CONTAINER : phone_battery_raw.csv
2020-12-15 04:15:39 +01:00
EPISODE_THRESHOLD_BETWEEN_ROWS : 30 # minutes. Max time difference for two consecutive rows to be considered within the same battery episode.
PROVIDERS :
RAPIDS :
2021-10-22 04:54:19 +02:00
COMPUTE : True
2020-12-15 04:15:39 +01:00
FEATURES : [ "countdischarge" , "sumdurationdischarge" , "countcharge" , "sumdurationcharge" , "avgconsumptionrate" , "maxconsumptionrate" ]
2021-03-15 00:52:14 +01:00
SRC_SCRIPT : src/features/phone_battery/rapids/main.py
2020-12-15 04:15:39 +01:00
# See https://www.rapids.science/latest/features/phone-bluetooth/
PHONE_BLUETOOTH :
2021-03-14 06:09:08 +01:00
CONTAINER : phone_bluetooth_raw.csv
2020-09-03 22:30:13 +02:00
PROVIDERS :
RAPIDS :
2021-04-08 00:09:08 +02:00
COMPUTE : FALSE
2020-12-15 04:15:39 +01:00
FEATURES : [ "countscans" , "uniquedevices" , "countscansmostuniquedevice" ]
2021-03-15 00:52:14 +01:00
SRC_SCRIPT : src/features/phone_bluetooth/rapids/main.R
2020-12-15 07:03:14 +01:00
DORYAB :
2021-06-24 00:56:24 +02:00
COMPUTE : True
2020-12-15 07:03:14 +01:00
FEATURES :
ALL :
DEVICES : [ "countscans" , "uniquedevices" , "meanscans" , "stdscans" ]
SCANS_MOST_FREQUENT_DEVICE : [ "withinsegments" , "acrosssegments" , "acrossdataset" ]
SCANS_LEAST_FREQUENT_DEVICE : [ "withinsegments" , "acrosssegments" , "acrossdataset" ]
OWN :
DEVICES : [ "countscans" , "uniquedevices" , "meanscans" , "stdscans" ]
SCANS_MOST_FREQUENT_DEVICE : [ "withinsegments" , "acrosssegments" , "acrossdataset" ]
SCANS_LEAST_FREQUENT_DEVICE : [ "withinsegments" , "acrosssegments" , "acrossdataset" ]
OTHERS :
DEVICES : [ "countscans" , "uniquedevices" , "meanscans" , "stdscans" ]
SCANS_MOST_FREQUENT_DEVICE : [ "withinsegments" , "acrosssegments" , "acrossdataset" ]
SCANS_LEAST_FREQUENT_DEVICE : [ "withinsegments" , "acrosssegments" , "acrossdataset" ]
2021-03-15 00:52:14 +01:00
SRC_SCRIPT : src/features/phone_bluetooth/doryab/main.py
2020-09-03 22:30:13 +02:00
2020-12-15 04:15:39 +01:00
# See https://www.rapids.science/latest/features/phone-calls/
2020-10-19 23:13:10 +02:00
PHONE_CALLS :
2021-03-14 06:09:08 +01:00
CONTAINER : phone_calls_raw.csv
2020-09-04 17:40:59 +02:00
PROVIDERS :
RAPIDS :
2021-06-09 01:24:35 +02:00
COMPUTE : True
2021-09-11 05:47:55 +02:00
FEATURES_TYPE : EPISODES
2020-09-04 17:40:59 +02:00
CALL_TYPES : [ missed, incoming, outgoing]
FEATURES :
missed : [ count, distinctcontacts, timefirstcall, timelastcall, countmostfrequentcontact]
incoming : [ count, distinctcontacts, meanduration, sumduration, minduration, maxduration, stdduration, modeduration, entropyduration, timefirstcall, timelastcall, countmostfrequentcontact]
outgoing : [ count, distinctcontacts, meanduration, sumduration, minduration, maxduration, stdduration, modeduration, entropyduration, timefirstcall, timelastcall, countmostfrequentcontact]
2021-03-15 00:52:14 +01:00
SRC_SCRIPT : src/features/phone_calls/rapids/main.R
2020-09-03 22:30:13 +02:00
2020-12-15 04:15:39 +01:00
# See https://www.rapids.science/latest/features/phone-conversation/
PHONE_CONVERSATION :
2021-03-13 00:14:49 +01:00
CONTAINER :
2021-03-14 06:09:08 +01:00
ANDROID : phone_conversation_raw.csv
IOS : phone_conversation_raw.csv
2020-12-15 04:15:39 +01:00
PROVIDERS :
RAPIDS :
2021-06-09 01:24:35 +02:00
COMPUTE : True
2020-12-15 04:15:39 +01:00
FEATURES : [ "minutessilence" , "minutesnoise" , "minutesvoice" , "minutesunknown" , "sumconversationduration" , "avgconversationduration" ,
"sdconversationduration" , "minconversationduration" , "maxconversationduration" , "timefirstconversation" , "timelastconversation" , "noisesumenergy" ,
"noiseavgenergy" , "noisesdenergy" , "noiseminenergy" , "noisemaxenergy" , "voicesumenergy" ,
"voiceavgenergy" , "voicesdenergy" , "voiceminenergy" , "voicemaxenergy" , "silencesensedfraction" , "noisesensedfraction" ,
"voicesensedfraction" , "unknownsensedfraction" , "silenceexpectedfraction" , "noiseexpectedfraction" , "voiceexpectedfraction" ,
"unknownexpectedfraction" , "countconversation" ]
RECORDING_MINUTES : 1
PAUSED_MINUTES : 3
2021-03-15 00:52:14 +01:00
SRC_SCRIPT : src/features/phone_conversation/rapids/main.py
2020-12-15 04:15:39 +01:00
# See https://www.rapids.science/latest/features/phone-data-yield/
PHONE_DATA_YIELD :
2021-08-04 02:01:45 +02:00
SENSORS : [ PHONE_SCREEN, PHONE_LIGHT]
2020-12-15 04:15:39 +01:00
PROVIDERS :
RAPIDS :
2021-08-06 20:54:08 +02:00
COMPUTE : True
2020-12-15 04:15:39 +01:00
FEATURES : [ ratiovalidyieldedminutes, ratiovalidyieldedhours]
2021-03-14 06:09:08 +01:00
MINUTE_RATIO_THRESHOLD_FOR_VALID_YIELDED_HOURS : 0.5 # 0 to 1, minimum percentage of valid minutes in an hour to be considered valid.
2021-03-15 00:52:14 +01:00
SRC_SCRIPT : src/features/phone_data_yield/rapids/main.R
2020-12-15 04:15:39 +01:00
2021-01-14 21:24:55 +01:00
# See https://www.rapids.science/latest/features/phone-keyboard/
2020-12-15 07:03:14 +01:00
PHONE_KEYBOARD :
2021-05-21 17:45:27 +02:00
CONTAINER : phone_keyboard_raw.csv
PROVIDERS :
RAPIDS :
2021-06-09 01:24:35 +02:00
COMPUTE : True
2021-05-21 17:45:27 +02:00
FEATURES : [ "sessioncount" , "averageinterkeydelay" , "averagesessionlength" , "changeintextlengthlessthanminusone" , "changeintextlengthequaltominusone" , "changeintextlengthequaltoone" , "changeintextlengthmorethanone" , "maxtextlength" , "lastmessagelength" , "totalkeyboardtouches" ]
SRC_SCRIPT : src/features/phone_keyboard/rapids/main.py
2020-12-15 07:03:14 +01:00
2020-12-15 04:15:39 +01:00
# See https://www.rapids.science/latest/features/phone-light/
PHONE_LIGHT :
2021-03-14 06:09:08 +01:00
CONTAINER : phone_light_raw.csv
2020-12-15 04:15:39 +01:00
PROVIDERS :
RAPIDS :
2021-06-29 17:52:16 +02:00
COMPUTE : True
2020-12-15 04:15:39 +01:00
FEATURES : [ "count" , "maxlux" , "minlux" , "avglux" , "medianlux" , "stdlux" ]
2021-03-15 00:52:14 +01:00
SRC_SCRIPT : src/features/phone_light/rapids/main.py
2020-12-15 04:15:39 +01:00
# See https://www.rapids.science/latest/features/phone-locations/
2020-10-19 23:13:10 +02:00
PHONE_LOCATIONS :
2021-04-09 18:05:25 +02:00
CONTAINER : phone_locations_raw.csv
LOCATIONS_TO_USE : GPS # ALL, GPS, ALL_RESAMPLED, OR FUSED_RESAMPLED
2020-10-19 23:13:10 +02:00
FUSED_RESAMPLED_CONSECUTIVE_THRESHOLD : 30 # minutes, only replicate location samples to the next sensed bin if the phone did not stop collecting data for more than this threshold
FUSED_RESAMPLED_TIME_SINCE_VALID_LOCATION : 720 # minutes, only replicate location samples to consecutive sensed bins if they were logged within this threshold after a valid location row
2021-09-15 20:28:09 +02:00
ACCURACY_LIMIT : 100 # meters, drops location coordinates with an accuracy higher than this. This number means there's a 68% probability the true location is within this radius
2020-10-19 23:13:10 +02:00
PROVIDERS :
DORYAB :
2021-06-09 01:24:35 +02:00
COMPUTE : True
2021-04-09 18:05:25 +02:00
FEATURES : [ "locationvariance" , "loglocationvariance" , "totaldistance" , "avgspeed" , "varspeed" , "numberofsignificantplaces" , "numberlocationtransitions" , "radiusgyration" , "timeattop1location" , "timeattop2location" , "timeattop3location" , "movingtostaticratio" , "outlierstimepercent" , "maxlengthstayatclusters" , "minlengthstayatclusters" , "avglengthstayatclusters" , "stdlengthstayatclusters" , "locationentropy" , "normalizedlocationentropy" , "timeathome" ]
2020-10-19 23:13:10 +02:00
DBSCAN_EPS : 10 # meters
2021-04-09 18:05:25 +02:00
DBSCAN_MINSAMPLES : 3
2020-10-19 23:13:10 +02:00
THRESHOLD_STATIC : 1 # km/h
2021-04-09 18:05:25 +02:00
MAXIMUM_ROW_GAP : 300 # seconds
2020-10-19 23:13:10 +02:00
MINUTES_DATA_USED : False
2021-04-09 18:05:25 +02:00
CLUSTER_ON : PARTICIPANT_DATASET # PARTICIPANT_DATASET, TIME_SEGMENT, TIME_SEGMENT_INSTANCE
INFER_HOME_LOCATION_STRATEGY : DORYAB_STRATEGY # DORYAB_STRATEGY, SUN_LI_VEGA_STRATEGY
MINIMUM_DAYS_TO_DETECT_HOME_CHANGES : 3
CLUSTERING_ALGORITHM : DBSCAN # DBSCAN, OPTICS
RADIUS_FOR_HOME : 100
2021-03-15 00:52:14 +01:00
SRC_SCRIPT : src/features/phone_locations/doryab/main.py
2020-10-19 23:13:10 +02:00
BARNETT :
COMPUTE : False
FEATURES : [ "hometime" , "disttravelled" , "rog" , "maxdiam" , "maxhomedist" , "siglocsvisited" , "avgflightlen" , "stdflightlen" , "avgflightdur" , "stdflightdur" , "probpause" , "siglocentropy" , "circdnrtn" , "wkenddayrtn" ]
2021-03-14 06:09:08 +01:00
IF_MULTIPLE_TIMEZONES : USE_MOST_COMMON
2020-10-19 23:13:10 +02:00
MINUTES_DATA_USED : False # Use this for quality control purposes, how many minutes of data (location coordinates gruped by minute) were used to compute features
2021-03-15 00:52:14 +01:00
SRC_SCRIPT : src/features/phone_locations/barnett/main.R
2020-10-19 23:13:10 +02:00
2021-03-10 22:26:50 +01:00
# See https://www.rapids.science/latest/features/phone-log/
PHONE_LOG :
2021-03-13 00:14:49 +01:00
CONTAINER :
2021-03-10 22:26:50 +01:00
ANDROID : aware_log
IOS : ios_aware_log
PROVIDERS : # None implemented yet but this sensor can be used in PHONE_DATA_YIELD
2020-12-15 04:15:39 +01:00
# See https://www.rapids.science/latest/features/phone-messages/
PHONE_MESSAGES :
2021-03-14 06:09:08 +01:00
CONTAINER : phone_messages_raw.csv
2020-10-19 23:13:10 +02:00
PROVIDERS :
RAPIDS :
2021-07-07 07:22:49 +02:00
COMPUTE : True
2020-12-15 04:15:39 +01:00
MESSAGES_TYPES : [ received, sent]
FEATURES :
received : [ count, distinctcontacts, timefirstmessage, timelastmessage, countmostfrequentcontact]
sent : [ count, distinctcontacts, timefirstmessage, timelastmessage, countmostfrequentcontact]
2021-03-15 00:52:14 +01:00
SRC_SCRIPT : src/features/phone_messages/rapids/main.R
2020-10-19 23:13:10 +02:00
2020-12-15 04:15:39 +01:00
# See https://www.rapids.science/latest/features/phone-screen/
2020-10-19 23:13:10 +02:00
PHONE_SCREEN :
2021-04-21 01:02:08 +02:00
CONTAINER : phone_screen_raw.csv
2020-10-19 23:13:10 +02:00
PROVIDERS :
RAPIDS :
COMPUTE : False
REFERENCE_HOUR_FIRST_USE : 0
IGNORE_EPISODES_SHORTER_THAN : 0 # in minutes, set to 0 to disable
IGNORE_EPISODES_LONGER_THAN : 0 # in minutes, set to 0 to disable
FEATURES : [ "countepisode" , "sumduration" , "maxduration" , "minduration" , "avgduration" , "stdduration" , "firstuseafter" ] # "episodepersensedminutes" needs to be added later
EPISODE_TYPES : [ "unlock" ]
2021-03-15 00:52:14 +01:00
SRC_SCRIPT : src/features/phone_screen/rapids/main.py
2020-10-19 23:13:10 +02:00
2020-12-15 04:15:39 +01:00
# See https://www.rapids.science/latest/features/phone-wifi-connected/
PHONE_WIFI_CONNECTED :
2021-03-14 06:09:08 +01:00
CONTAINER : phone_wifi_connected_raw.csv
2020-09-04 22:05:05 +02:00
PROVIDERS :
RAPIDS :
2021-06-08 23:16:06 +02:00
COMPUTE : True
2020-12-15 04:15:39 +01:00
FEATURES : [ "countscans" , "uniquedevices" , "countscansmostuniquedevice" ]
2021-03-15 00:52:14 +01:00
SRC_SCRIPT : src/features/phone_wifi_connected/rapids/main.R
2020-09-11 23:55:09 +02:00
2020-12-15 04:15:39 +01:00
# See https://www.rapids.science/latest/features/phone-wifi-visible/
2020-10-19 23:13:10 +02:00
PHONE_WIFI_VISIBLE :
2021-03-14 06:09:08 +01:00
CONTAINER : phone_wifi_visible_raw.csv
2020-10-19 23:13:10 +02:00
PROVIDERS :
RAPIDS :
2021-06-08 23:16:06 +02:00
COMPUTE : True
2020-10-19 23:13:10 +02:00
FEATURES : [ "countscans" , "uniquedevices" , "countscansmostuniquedevice" ]
2021-03-15 00:52:14 +01:00
SRC_SCRIPT : src/features/phone_wifi_visible/rapids/main.R
2020-10-19 23:13:10 +02:00
2020-12-15 04:15:39 +01:00
########################################################################################################################
# FITBIT #
########################################################################################################################
2021-03-15 00:52:14 +01:00
# See https://www.rapids.science/latest/setup/configuration/#data-stream-configuration
2021-03-14 06:09:08 +01:00
FITBIT_DATA_STREAMS :
2021-04-17 00:32:20 +02:00
USE : fitbitparsed_csv
2021-03-14 06:09:08 +01:00
# AVAILABLE:
fitbitjson_mysql :
DATABASE_GROUP : MY_GROUP
2021-04-26 05:35:14 +02:00
SLEEP_SUMMARY_LAST_NIGHT_END : 660 # a number ranged from 0 (midnight) to 1439 (23:59) which denotes number of minutes after midnight. By default, 660 (11:00).
2021-03-14 06:09:08 +01:00
fitbitparsed_mysql :
DATABASE_GROUP : MY_GROUP
2021-04-26 05:35:14 +02:00
SLEEP_SUMMARY_LAST_NIGHT_END : 660 # a number ranged from 0 (midnight) to 1439 (23:59) which denotes number of minutes after midnight. By default, 660 (11:00).
2021-03-14 06:09:08 +01:00
fitbitjson_csv :
FOLDER : data/external/fitbit_csv
2021-04-26 05:35:14 +02:00
SLEEP_SUMMARY_LAST_NIGHT_END : 660 # a number ranged from 0 (midnight) to 1439 (23:59) which denotes number of minutes after midnight. By default, 660 (11:00).
2021-03-14 06:09:08 +01:00
fitbitparsed_csv :
2021-04-17 00:32:20 +02:00
FOLDER : tests/data/external/aware_csv
2021-04-26 05:35:14 +02:00
SLEEP_SUMMARY_LAST_NIGHT_END : 660 # a number ranged from 0 (midnight) to 1439 (23:59) which denotes number of minutes after midnight. By default, 660 (11:00).
2020-12-15 04:15:39 +01:00
# Sensors ------
2021-04-20 18:02:21 +02:00
FITBIT_CALORIES_INTRADAY :
CONTAINER : fitbit_calories_intraday_raw.csv
PROVIDERS :
RAPIDS :
2021-06-09 01:24:35 +02:00
COMPUTE : True
2021-04-20 18:02:21 +02:00
EPISODE_TYPE : [ sedentary, lightlyactive, fairlyactive, veryactive, mvpa, lowmet, highmet]
EPISODE_TIME_THRESHOLD : 5 # minutes
EPISODE_MET_THRESHOLD : 3
EPISODE_MVPA_CATEGORIES : [ fairlyactive, veryactive]
EPISODE_REFERENCE_TIME : MIDNIGHT # MIDNIGHT or START_OF_THE_SEGMENT
FEATURES : [ count, sumduration, avgduration, minduration, maxduration, stdduration, starttimefirst, endtimefirst, starttimelast, endtimelast, starttimelongest, endtimelongest, summet, avgmet, maxmet, minmet, stdmet, sumcalories, avgcalories, maxcalories, mincalories, stdcalories]
SRC_SCRIPT : src/features/fitbit_calories_intraday/rapids/main.R
2020-12-15 04:15:39 +01:00
2021-03-14 06:09:08 +01:00
# See https://www.rapids.science/latest/features/fitbit-data-yield/
FITBIT_DATA_YIELD :
SENSOR : FITBIT_HEARTRATE_INTRADAY
PROVIDERS :
RAPIDS :
2021-08-04 02:01:45 +02:00
COMPUTE : True
2021-03-14 06:09:08 +01:00
FEATURES : [ ratiovalidyieldedminutes, ratiovalidyieldedhours]
MINUTE_RATIO_THRESHOLD_FOR_VALID_YIELDED_HOURS : 0.5 # 0 to 1, minimum percentage of valid minutes in an hour to be considered valid.
2021-03-15 00:52:14 +01:00
SRC_SCRIPT : src/features/fitbit_data_yield/rapids/main.R
2021-03-14 06:09:08 +01:00
2020-12-15 04:15:39 +01:00
# See https://www.rapids.science/latest/features/fitbit-heartrate-summary/
FITBIT_HEARTRATE_SUMMARY :
2021-07-20 22:12:36 +02:00
CONTAINER : fitbit_heartrate_summary_raw.csv
2020-10-19 23:13:10 +02:00
PROVIDERS :
RAPIDS :
2021-07-20 22:12:36 +02:00
COMPUTE : True
FEATURES : [ "maxrestinghr" , "minrestinghr" , "avgrestinghr" , "medianrestinghr" , "moderestinghr" , "stdrestinghr" , "diffmaxmoderestinghr" , "diffminmoderestinghr" , "entropyrestinghr" , "sumcaloriesoutofrange" , "maxcaloriesoutofrange" , "mincaloriesoutofrange" , "avgcaloriesoutofrange" , "mediancaloriesoutofrange" , "stdcaloriesoutofrange" , "entropycaloriesoutofrange" , "sumcaloriesfatburn" , "maxcaloriesfatburn" , "mincaloriesfatburn" , "avgcaloriesfatburn" , "mediancaloriesfatburn" , "stdcaloriesfatburn" , "entropycaloriesfatburn" , "sumcaloriescardio" , "maxcaloriescardio" , "mincaloriescardio" , "avgcaloriescardio" , "mediancaloriescardio" , "stdcaloriescardio" , "entropycaloriescardio" , "sumcaloriespeak" , "maxcaloriespeak" , "mincaloriespeak" , "avgcaloriespeak" , "mediancaloriespeak" , "stdcaloriespeak" , "entropycaloriespeak" ] # calories features' accuracy depend on the accuracy of the participants fitbit profile (e.g. height, weight) use these with care : [ "sumcaloriesoutofrange" , "maxcaloriesoutofrange" , "mincaloriesoutofrange" , "avgcaloriesoutofrange" , "mediancaloriesoutofrange" , "stdcaloriesoutofrange" , "entropycaloriesoutofrange" , "sumcaloriesfatburn" , "maxcaloriesfatburn" , "mincaloriesfatburn" , "avgcaloriesfatburn" , "mediancaloriesfatburn" , "stdcaloriesfatburn" , "entropycaloriesfatburn" , "sumcaloriescardio" , "maxcaloriescardio" , "mincaloriescardio" , "avgcaloriescardio" , "mediancaloriescardio" , "stdcaloriescardio" , "entropycaloriescardio" , "sumcaloriespeak" , "maxcaloriespeak" , "mincaloriespeak" , "avgcaloriespeak" , "mediancaloriespeak" , "stdcaloriespeak" , "entropycaloriespeak" ]
2021-03-15 00:52:14 +01:00
SRC_SCRIPT : src/features/fitbit_heartrate_summary/rapids/main.py
2020-10-19 23:13:10 +02:00
2020-12-15 04:15:39 +01:00
# See https://www.rapids.science/latest/features/fitbit-heartrate-intraday/
FITBIT_HEARTRATE_INTRADAY :
2021-07-20 22:59:27 +02:00
CONTAINER : fitbit_heartrate_intraday_raw.csv
2020-09-10 20:01:32 +02:00
PROVIDERS :
RAPIDS :
2021-07-20 22:59:27 +02:00
COMPUTE : True
2020-12-15 04:15:39 +01:00
FEATURES : [ "maxhr" , "minhr" , "avghr" , "medianhr" , "modehr" , "stdhr" , "diffmaxmodehr" , "diffminmodehr" , "entropyhr" , "minutesonoutofrangezone" , "minutesonfatburnzone" , "minutesoncardiozone" , "minutesonpeakzone" ]
2021-03-15 00:52:14 +01:00
SRC_SCRIPT : src/features/fitbit_heartrate_intraday/rapids/main.py
2020-10-19 23:13:10 +02:00
2020-12-15 04:15:39 +01:00
# See https://www.rapids.science/latest/features/fitbit-sleep-summary/
FITBIT_SLEEP_SUMMARY :
2021-04-23 02:19:47 +02:00
CONTAINER : fitbit_sleep_summary_raw.csv
2020-12-15 04:15:39 +01:00
PROVIDERS :
RAPIDS :
2021-06-09 01:24:35 +02:00
COMPUTE : True
2021-04-23 02:19:47 +02:00
FEATURES : [ "firstwaketime" , "lastwaketime" , "firstbedtime" , "lastbedtime" , "countepisode" , "avgefficiency" , "sumdurationafterwakeup" , "sumdurationasleep" , "sumdurationawake" , "sumdurationtofallasleep" , "sumdurationinbed" , "avgdurationafterwakeup" , "avgdurationasleep" , "avgdurationawake" , "avgdurationtofallasleep" , "avgdurationinbed" ]
2020-12-15 04:15:39 +01:00
SLEEP_TYPES : [ "main" , "nap" , "all" ]
2021-03-15 00:52:14 +01:00
SRC_SCRIPT : src/features/fitbit_sleep_summary/rapids/main.py
2020-10-19 23:13:10 +02:00
2021-03-14 06:09:08 +01:00
# See https://www.rapids.science/latest/features/fitbit-sleep-intraday/
FITBIT_SLEEP_INTRADAY :
2021-04-26 05:35:14 +02:00
CONTAINER : fitbit_sleep_intraday_raw.csv
2021-03-14 06:09:08 +01:00
PROVIDERS :
RAPIDS :
2021-06-09 01:24:35 +02:00
COMPUTE : True
2021-03-14 06:09:08 +01:00
FEATURES :
LEVELS_AND_TYPES : [ countepisode, sumduration, maxduration, minduration, avgduration, medianduration, stdduration]
RATIOS_TYPE : [ count, duration]
RATIOS_SCOPE : [ ACROSS_LEVELS, ACROSS_TYPES, WITHIN_LEVELS, WITHIN_TYPES]
SLEEP_LEVELS :
2021-04-23 02:19:47 +02:00
INCLUDE_ALL_GROUPS : True
2021-03-14 06:09:08 +01:00
CLASSIC : [ awake, restless, asleep]
STAGES : [ wake, deep, light, rem]
UNIFIED : [ awake, asleep]
2021-04-23 02:19:47 +02:00
SLEEP_TYPES : [ main, nap, all]
2021-03-15 00:52:14 +01:00
SRC_SCRIPT : src/features/fitbit_sleep_intraday/rapids/main.py
2021-03-14 06:09:08 +01:00
PRICE :
2021-06-09 01:24:35 +02:00
COMPUTE : True
2021-04-23 02:19:47 +02:00
FEATURES : [ avgduration, avgratioduration, avgstarttimeofepisodemain, avgendtimeofepisodemain, avgmidpointofepisodemain, stdstarttimeofepisodemain, stdendtimeofepisodemain, stdmidpointofepisodemain, socialjetlag, rmssdmeanstarttimeofepisodemain, rmssdmeanendtimeofepisodemain, rmssdmeanmidpointofepisodemain, rmssdmedianstarttimeofepisodemain, rmssdmedianendtimeofepisodemain, rmssdmedianmidpointofepisodemain]
2021-03-14 06:09:08 +01:00
SLEEP_LEVELS :
2021-04-23 02:19:47 +02:00
INCLUDE_ALL_GROUPS : True
2021-03-14 06:09:08 +01:00
CLASSIC : [ awake, restless, asleep]
STAGES : [ wake, deep, light, rem]
UNIFIED : [ awake, asleep]
DAY_TYPES : [ WEEKEND, WEEK, ALL]
2021-04-26 05:35:14 +02:00
LAST_NIGHT_END : 660 # number of minutes after midnight (11:00) 11*60
2021-03-15 00:52:14 +01:00
SRC_SCRIPT : src/features/fitbit_sleep_intraday/price/main.py
2021-03-14 06:09:08 +01:00
2020-12-15 04:15:39 +01:00
# See https://www.rapids.science/latest/features/fitbit-steps-summary/
FITBIT_STEPS_SUMMARY :
2021-07-28 02:08:09 +02:00
CONTAINER : fitbit_steps_summary_raw.csv
2020-10-21 22:46:40 +02:00
PROVIDERS :
RAPIDS :
2021-07-28 02:08:09 +02:00
COMPUTE : True
2020-12-15 04:15:39 +01:00
FEATURES : [ "maxsumsteps" , "minsumsteps" , "avgsumsteps" , "mediansumsteps" , "stdsumsteps" ]
2021-03-15 00:52:14 +01:00
SRC_SCRIPT : src/features/fitbit_steps_summary/rapids/main.py
2020-10-26 23:18:11 +01:00
2020-12-15 04:15:39 +01:00
# See https://www.rapids.science/latest/features/fitbit-steps-intraday/
FITBIT_STEPS_INTRADAY :
2021-07-27 04:34:20 +02:00
CONTAINER : fitbit_steps_intraday_raw.csv
2021-05-19 00:27:12 +02:00
EXCLUDE_SLEEP : # you can exclude step data that was logged during sleep periods
TIME_BASED :
EXCLUDE : False
START_TIME : "23:00"
END_TIME : "07:00"
FITBIT_BASED :
EXCLUDE : False
2020-10-21 22:46:40 +02:00
PROVIDERS :
RAPIDS :
2021-07-27 04:34:20 +02:00
COMPUTE : True
2020-10-21 22:46:40 +02:00
FEATURES :
2021-10-31 02:38:59 +01:00
STEPS : [ "sum" , "max" , "min" , "avg" , "std" , "firststeptime" , "laststeptime" ]
2020-10-21 22:46:40 +02:00
SEDENTARY_BOUT : [ "countepisode" , "sumduration" , "maxduration" , "minduration" , "avgduration" , "stdduration" ]
ACTIVE_BOUT : [ "countepisode" , "sumduration" , "maxduration" , "minduration" , "avgduration" , "stdduration" ]
THRESHOLD_ACTIVE_BOUT : 10 # steps
INCLUDE_ZERO_STEP_ROWS : False
2021-03-15 00:52:14 +01:00
SRC_SCRIPT : src/features/fitbit_steps_intraday/rapids/main.py
2020-10-19 23:13:10 +02:00
2021-03-14 06:09:08 +01:00
########################################################################################################################
# EMPATICA #
########################################################################################################################
EMPATICA_DATA_STREAMS :
USE : empatica_zip
# AVAILABLE:
empatica_zip :
FOLDER : data/external/empatica
# Sensors ------
# See https://www.rapids.science/latest/features/empatica-accelerometer/
EMPATICA_ACCELEROMETER :
CONTAINER : ACC
PROVIDERS :
DBDP :
COMPUTE : False
FEATURES : [ "maxmagnitude" , "minmagnitude" , "avgmagnitude" , "medianmagnitude" , "stdmagnitude" ]
2021-03-15 00:52:14 +01:00
SRC_SCRIPT : src/features/empatica_accelerometer/dbdp/main.py
2020-10-26 23:18:11 +01:00
2021-03-14 06:09:08 +01:00
# See https://www.rapids.science/latest/features/empatica-heartrate/
EMPATICA_HEARTRATE :
CONTAINER : HR
PROVIDERS :
DBDP :
COMPUTE : False
FEATURES : [ "maxhr" , "minhr" , "avghr" , "medianhr" , "modehr" , "stdhr" , "diffmaxmodehr" , "diffminmodehr" , "entropyhr" ]
2021-03-15 00:52:14 +01:00
SRC_SCRIPT : src/features/empatica_heartrate/dbdp/main.py
2021-03-14 06:09:08 +01:00
# See https://www.rapids.science/latest/features/empatica-temperature/
EMPATICA_TEMPERATURE :
CONTAINER : TEMP
PROVIDERS :
DBDP :
COMPUTE : False
FEATURES : [ "maxtemp" , "mintemp" , "avgtemp" , "mediantemp" , "modetemp" , "stdtemp" , "diffmaxmodetemp" , "diffminmodetemp" , "entropytemp" ]
2021-03-15 00:52:14 +01:00
SRC_SCRIPT : src/features/empatica_temperature/dbdp/main.py
2021-03-14 06:09:08 +01:00
# See https://www.rapids.science/latest/features/empatica-electrodermal-activity/
EMPATICA_ELECTRODERMAL_ACTIVITY :
CONTAINER : EDA
PROVIDERS :
DBDP :
COMPUTE : False
FEATURES : [ "maxeda" , "mineda" , "avgeda" , "medianeda" , "modeeda" , "stdeda" , "diffmaxmodeeda" , "diffminmodeeda" , "entropyeda" ]
2021-03-15 00:52:14 +01:00
SRC_SCRIPT : src/features/empatica_electrodermal_activity/dbdp/main.py
2021-03-14 06:09:08 +01:00
# See https://www.rapids.science/latest/features/empatica-blood-volume-pulse/
EMPATICA_BLOOD_VOLUME_PULSE :
CONTAINER : BVP
PROVIDERS :
DBDP :
COMPUTE : False
FEATURES : [ "maxbvp" , "minbvp" , "avgbvp" , "medianbvp" , "modebvp" , "stdbvp" , "diffmaxmodebvp" , "diffminmodebvp" , "entropybvp" ]
2021-03-15 00:52:14 +01:00
SRC_SCRIPT : src/features/empatica_blood_volume_pulse/dbdp/main.py
2021-03-14 06:09:08 +01:00
# See https://www.rapids.science/latest/features/empatica-inter-beat-interval/
EMPATICA_INTER_BEAT_INTERVAL :
CONTAINER : IBI
PROVIDERS :
DBDP :
COMPUTE : False
FEATURES : [ "maxibi" , "minibi" , "avgibi" , "medianibi" , "modeibi" , "stdibi" , "diffmaxmodeibi" , "diffminmodeibi" , "entropyibi" ]
2021-03-15 00:52:14 +01:00
SRC_SCRIPT : src/features/empatica_inter_beat_interval/dbdp/main.py
2021-03-14 06:09:08 +01:00
# See https://www.rapids.science/latest/features/empatica-tags/
EMPATICA_TAGS :
CONTAINER : TAGS
PROVIDERS : # None implemented yet
2020-10-26 23:18:11 +01:00
2020-12-15 04:15:39 +01:00
########################################################################################################################
# PLOTS #
########################################################################################################################
2021-03-14 06:09:08 +01:00
# Data quality ------
# See https://www.rapids.science/latest/visualizations/data-quality-visualizations/#1-histograms-of-phone-data-yield
2020-12-15 04:15:39 +01:00
HISTOGRAM_PHONE_DATA_YIELD :
2020-10-19 23:13:10 +02:00
PLOT : False
2021-03-14 06:09:08 +01:00
# See https://www.rapids.science/latest/visualizations/data-quality-visualizations/#2-heatmaps-of-overall-data-yield
2020-12-15 04:15:39 +01:00
HEATMAP_PHONE_DATA_YIELD_PER_PARTICIPANT_PER_TIME_SEGMENT :
2020-10-19 23:13:10 +02:00
PLOT : False
2021-04-15 02:52:45 +02:00
TIME : ABSOLUTE_TIME # ABSOLUTE_TIME or RELATIVE_TIME
2020-10-19 23:13:10 +02:00
2021-03-14 06:09:08 +01:00
# See https://www.rapids.science/latest/visualizations/data-quality-visualizations/#3-heatmap-of-recorded-phone-sensors
2020-12-15 04:15:39 +01:00
HEATMAP_SENSORS_PER_MINUTE_PER_TIME_SEGMENT :
2020-10-19 23:13:10 +02:00
PLOT : False
2021-03-14 06:09:08 +01:00
# See https://www.rapids.science/latest/visualizations/data-quality-visualizations/#4-heatmap-of-sensor-row-count
2020-12-15 04:15:39 +01:00
HEATMAP_SENSOR_ROW_COUNT_PER_TIME_SEGMENT :
2020-10-19 23:13:10 +02:00
PLOT : False
2020-12-15 04:15:39 +01:00
SENSORS : [ PHONE_ACCELEROMETER, PHONE_ACTIVITY_RECOGNITION, PHONE_APPLICATIONS_FOREGROUND, PHONE_BATTERY, PHONE_BLUETOOTH, PHONE_CALLS, PHONE_CONVERSATION, PHONE_LIGHT, PHONE_LOCATIONS, PHONE_MESSAGES, PHONE_SCREEN, PHONE_WIFI_CONNECTED, PHONE_WIFI_VISIBLE]
2020-10-19 23:13:10 +02:00
2021-03-14 06:09:08 +01:00
# Features ------
# See https://www.rapids.science/latest/visualizations/feature-visualizations/#1-heatmap-correlation-matrix
2020-12-15 04:15:39 +01:00
HEATMAP_FEATURE_CORRELATION_MATRIX :
2020-10-19 23:13:10 +02:00
PLOT : False
2020-12-15 04:15:39 +01:00
MIN_ROWS_RATIO : 0.5
CORR_THRESHOLD : 0.1
CORR_METHOD : "pearson" # choose from {"pearson", "kendall", "spearman"}
2020-10-19 23:13:10 +02:00