2020-11-26 01:42:11 +01:00
# See https://www.rapids.science/latest/setup/configuration/#database-credentials
2020-11-04 19:27:58 +01:00
DATABASE_GROUP : &database_group
MY_GROUP
2019-10-24 22:27:43 +02:00
2020-11-26 01:42:11 +01:00
# See https://www.rapids.science/latest/setup/configuration/#timezone-of-your-study
2019-11-05 21:17:20 +01:00
TIMEZONE : &timezone
2019-11-06 23:12:06 +01:00
America/New_York
2019-11-05 21:17:20 +01:00
2020-11-26 01:42:11 +01:00
# See https://www.rapids.science/latest/setup/configuration/#participant-files
2021-02-02 23:34:56 +01:00
PIDS : [ e03]
2020-02-10 22:45:34 +01:00
2020-11-26 01:42:11 +01:00
# See https://www.rapids.science/latest/setup/configuration/#automatic-creation-of-participant-files
2020-10-27 22:13:16 +01:00
CREATE_PARTICIPANT_FILES :
SOURCE :
TYPE : AWARE_DEVICE_TABLE #AWARE_DEVICE_TABLE or CSV_FILE
DATABASE_GROUP : *database_group
2020-11-04 19:27:58 +01:00
CSV_FILE_PATH : "data/external/example_participants.csv" # see docs for required format
2020-10-28 19:11:41 +01:00
TIMEZONE : *timezone
2020-10-21 01:12:01 +02:00
PHONE_SECTION :
2020-10-22 19:08:52 +02:00
ADD : TRUE
2020-10-27 22:13:16 +01:00
DEVICE_ID_COLUMN : device_id # column name
2020-10-21 01:12:01 +02:00
IGNORED_DEVICE_IDS : [ ]
FITBIT_SECTION :
2020-10-27 22:13:16 +01:00
ADD : TRUE
DEVICE_ID_COLUMN : device_id # column name
IGNORED_DEVICE_IDS : [ ]
2020-12-03 00:41:03 +01:00
# See https://www.rapids.science/latest/setup/configuration/#time-segments
TIME_SEGMENTS : &time_segments
2020-11-25 01:12:16 +01:00
TYPE : PERIODIC # FREQUENCY, PERIODIC, EVENT
2020-12-03 00:41:03 +01:00
FILE : "data/external/timesegments_periodic.csv"
2020-11-04 19:27:58 +01:00
INCLUDE_PAST_PERIODIC_SEGMENTS : FALSE # Only relevant if TYPE=PERIODIC, see docs
2020-02-10 22:45:34 +01:00
2020-10-27 22:13:16 +01:00
2020-11-26 01:42:11 +01:00
########################################################################################################################
# PHONE #
########################################################################################################################
# See https://www.rapids.science/latest/setup/configuration/#device-data-source-configuration
PHONE_DATA_CONFIGURATION :
SOURCE :
TYPE : DATABASE
DATABASE_GROUP : *database_group
DEVICE_ID_COLUMN : device_id # column name
TIMEZONE :
2020-12-04 22:49:29 +01:00
TYPE : SINGLE
VALUE : *timezone
2020-11-26 01:42:11 +01:00
# Sensors ------
# https://www.rapids.science/latest/features/phone-accelerometer/
PHONE_ACCELEROMETER :
TABLE : accelerometer
2020-11-25 01:12:16 +01:00
PROVIDERS :
RAPIDS :
2020-11-25 20:49:42 +01:00
COMPUTE : False
2020-11-26 01:42:11 +01:00
FEATURES : [ "maxmagnitude" , "minmagnitude" , "avgmagnitude" , "medianmagnitude" , "stdmagnitude" ]
SRC_FOLDER : "rapids" # inside src/features/phone_accelerometer
SRC_LANGUAGE : "python"
PANDA :
COMPUTE : False
VALID_SENSED_MINUTES : False
FEATURES :
exertional_activity_episode : [ "sumduration" , "maxduration" , "minduration" , "avgduration" , "medianduration" , "stdduration" ]
nonexertional_activity_episode : [ "sumduration" , "maxduration" , "minduration" , "avgduration" , "medianduration" , "stdduration" ]
SRC_FOLDER : "panda" # inside src/features/phone_accelerometer
SRC_LANGUAGE : "python"
2020-07-09 19:01:50 +02:00
2020-11-26 01:42:11 +01:00
# See https://www.rapids.science/latest/features/phone-activity-recognition/
PHONE_ACTIVITY_RECOGNITION :
TABLE :
ANDROID : plugin_google_activity_recognition
IOS : plugin_ios_activity_recognition
EPISODE_THRESHOLD_BETWEEN_ROWS : 5 # minutes. Max time difference for two consecutive rows to be considered within the same battery episode.
2020-08-31 19:34:15 +02:00
PROVIDERS :
RAPIDS :
2020-11-25 01:12:16 +01:00
COMPUTE : False
2020-11-26 01:42:11 +01:00
FEATURES : [ "count" , "mostcommonactivity" , "countuniqueactivities" , "durationstationary" , "durationmobile" , "durationvehicle" ]
ACTIVITY_CLASSES :
STATIONARY : [ "still" , "tilting" ]
MOBILE : [ "on_foot" , "walking" , "running" , "on_bicycle" ]
VEHICLE : [ "in_vehicle" ]
SRC_FOLDER : "rapids" # inside src/features/phone_activity_recognition
SRC_LANGUAGE : "python"
2021-01-13 23:08:19 +01:00
# See https://www.rapids.science/latest/features/phone-applications-crashes/
PHONE_APPLICATIONS_CRASHES :
TABLE : applications_crashes
2021-01-14 01:05:36 +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
2021-01-13 23:08:19 +01:00
PROVIDERS : # None implemented yet but this sensor can be used in PHONE_DATA_YIELD
2020-11-26 01:42:11 +01:00
# See https://www.rapids.science/latest/features/phone-applications-foreground/
PHONE_APPLICATIONS_FOREGROUND :
TABLE : applications_foreground
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 :
COMPUTE : False
SINGLE_CATEGORIES : [ "all" , "email" ]
MULTIPLE_CATEGORIES :
social : [ "socialnetworks" , "socialmediatools" ]
entertainment : [ "entertainment" , "gamingknowledge" , "gamingcasual" , "gamingadventure" , "gamingstrategy" , "gamingtoolscommunity" , "gamingroleplaying" , "gamingaction" , "gaminglogic" , "gamingsports" , "gamingsimulation" ]
SINGLE_APPS : [ "top1global" , "com.facebook.moments" , "com.google.android.youtube" , "com.twitter.android" ] # There's no entropy for single apps
EXCLUDED_CATEGORIES : [ ]
EXCLUDED_APPS : [ "com.fitbit.FitbitMobile" , "com.aware.plugin.upmc.cancer" ]
FEATURES : [ "count" , "timeoffirstuse" , "timeoflastuse" , "frequencyentropy" ]
SRC_FOLDER : "rapids" # inside src/features/phone_applications_foreground
SRC_LANGUAGE : "python"
2021-01-13 23:08:19 +01:00
# See https://www.rapids.science/latest/features/phone-applications-notifications/
PHONE_APPLICATIONS_NOTIFICATIONS :
TABLE : applications_notifications
2021-01-14 01:05:36 +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
2021-01-13 23:08:19 +01:00
PROVIDERS : # None implemented yet but this sensor can be used in PHONE_DATA_YIELD
# See https://www.rapids.science/latest/features/phone-aware-log/
PHONE_AWARE_LOG :
TABLE : aware_log
PROVIDERS : # None implemented yet but this sensor can be used in PHONE_DATA_YIELD
2020-11-26 01:42:11 +01:00
# See https://www.rapids.science/latest/features/phone-battery/
PHONE_BATTERY :
TABLE : battery
EPISODE_THRESHOLD_BETWEEN_ROWS : 30 # minutes. Max time difference for two consecutive rows to be considered within the same battery episode.
PROVIDERS :
RAPIDS :
COMPUTE : False
FEATURES : [ "countdischarge" , "sumdurationdischarge" , "countcharge" , "sumdurationcharge" , "avgconsumptionrate" , "maxconsumptionrate" ]
SRC_FOLDER : "rapids" # inside src/features/phone_battery
SRC_LANGUAGE : "python"
# See https://www.rapids.science/latest/features/phone-bluetooth/
PHONE_BLUETOOTH :
TABLE : bluetooth
PROVIDERS :
RAPIDS :
COMPUTE : False
FEATURES : [ "countscans" , "uniquedevices" , "countscansmostuniquedevice" ]
SRC_FOLDER : "rapids" # inside src/features/phone_bluetooth
2020-08-31 19:34:15 +02:00
SRC_LANGUAGE : "r"
2020-12-11 18:03:22 +01:00
DORYAB :
2020-12-12 23:01:46 +01:00
COMPUTE : FALSE
2020-12-11 18:03:22 +01:00
FEATURES :
2020-12-12 23:01:46 +01:00
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" ]
2020-12-11 18:03:22 +01:00
SRC_FOLDER : "doryab" # inside src/features/phone_bluetooth
SRC_LANGUAGE : "python"
2019-11-06 21:38:08 +01:00
2020-11-26 01:42:11 +01:00
# See https://www.rapids.science/latest/features/phone-calls/
2020-10-19 21:07:12 +02:00
PHONE_CALLS :
2020-10-21 01:12:01 +02:00
TABLE : calls
2020-08-28 23:50:49 +02:00
PROVIDERS :
RAPIDS :
2020-10-22 20:38:40 +02:00
COMPUTE : False
2020-08-28 23:50:49 +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]
SRC_LANGUAGE : "r"
2020-10-19 21:07:12 +02:00
SRC_FOLDER : "rapids" # inside src/features/phone_calls
2019-11-05 18:34:22 +01:00
2020-11-26 01:42:11 +01:00
# See https://www.rapids.science/latest/features/phone-conversation/
PHONE_CONVERSATION :
TABLE :
ANDROID : plugin_studentlife_audio_android
IOS : plugin_studentlife_audio
PROVIDERS :
RAPIDS :
COMPUTE : False
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
SRC_FOLDER : "rapids" # inside src/features/phone_conversation
SRC_LANGUAGE : "python"
# See https://www.rapids.science/latest/features/phone-data-yield/
PHONE_DATA_YIELD :
SENSORS : [ ]
PROVIDERS :
RAPIDS :
COMPUTE : False
FEATURES : [ ratiovalidyieldedminutes, ratiovalidyieldedhours]
MINUTE_RATIO_THRESHOLD_FOR_VALID_YIELDED_HOURS : 0.5 # 0 to 1 representing the number of minutes with at least
SRC_LANGUAGE : "r"
SRC_FOLDER : "rapids" # inside src/features/phone_data_yield
2021-01-13 23:08:19 +01:00
# See https://www.rapids.science/latest/features/phone-keyboard/
PHONE_KEYBOARD :
TABLE : keyboard
PROVIDERS : # None implemented yet but this sensor can be used in PHONE_DATA_YIELD
2020-11-26 01:42:11 +01:00
# See https://www.rapids.science/latest/features/phone-light/
PHONE_LIGHT :
TABLE : light
PROVIDERS :
RAPIDS :
COMPUTE : False
FEATURES : [ "count" , "maxlux" , "minlux" , "avglux" , "medianlux" , "stdlux" ]
SRC_FOLDER : "rapids" # inside src/features/phone_light
SRC_LANGUAGE : "python"
# See https://www.rapids.science/latest/features/phone-locations/
2020-10-19 21:07:12 +02:00
PHONE_LOCATIONS :
2020-10-21 01:12:01 +02:00
TABLE : locations
2021-01-14 20:27:35 +01:00
LOCATIONS_TO_USE : ALL_RESAMPLED # ALL, GPS, ALL_RESAMPLED, OR FUSED_RESAMPLED
2020-08-28 19:53:00 +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
PROVIDERS :
DORYAB :
2020-08-28 23:50:49 +02:00
COMPUTE : False
2021-02-03 15:46:29 +01:00
FEATURES : [ "locationvariance" , "loglocationvariance" , "totaldistance" , "averagespeed" , "varspeed" , "numberofsignificantplaces" , "numberlocationtransitions" , "radiusgyration" , "timeattop1location" , "timeattop2location" , "timeattop3location" , "movingtostaticratio" , "outlierstimepercent" , "maxlengthstayatclusters" , "minlengthstayatclusters" , "meanlengthstayatclusters" , "stdlengthstayatclusters" , "locationentropy" , "normalizedlocationentropy" ]
2021-01-14 20:27:35 +01:00
ACCURACY_LIMIT : 51 # 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
DBSCAN_EPS : 10 # meters
2020-08-28 19:53:00 +02:00
DBSCAN_MINSAMPLES : 5
THRESHOLD_STATIC : 1 # km/h
2021-02-02 17:14:23 +01:00
MAXIMUM_ROW_GAP : 300
MAXIMUM_ROW_DURATION : 60
2020-08-28 23:50:49 +02:00
MINUTES_DATA_USED : False
2021-02-02 18:04:48 +01:00
CLUSTER_ON : PARTICIPANT_DATASET # PARTICIPANT_DATASET,TIME_SEGMENT
2021-01-14 20:22:51 +01:00
CLUSTERING_ALGORITHM : DBSCAN #DBSCAN,OPTICS
2020-10-19 21:07:12 +02:00
SRC_FOLDER : "doryab" # inside src/features/phone_locations
2020-08-28 19:53:00 +02:00
SRC_LANGUAGE : "python"
BARNETT :
2020-08-28 23:50:49 +02:00
COMPUTE : False
2020-08-28 19:53:00 +02:00
FEATURES : [ "hometime" , "disttravelled" , "rog" , "maxdiam" , "maxhomedist" , "siglocsvisited" , "avgflightlen" , "stdflightlen" , "avgflightdur" , "stdflightdur" , "probpause" , "siglocentropy" , "circdnrtn" , "wkenddayrtn" ]
ACCURACY_LIMIT : 51 # 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
TIMEZONE : *timezone
2020-08-28 23:50:49 +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
2020-10-19 21:07:12 +02:00
SRC_FOLDER : "barnett" # inside src/features/phone_locations
2020-08-28 19:53:00 +02:00
SRC_LANGUAGE : "r"
2020-07-16 20:26:43 +02:00
2020-11-26 01:42:11 +01:00
# See https://www.rapids.science/latest/features/phone-messages/
PHONE_MESSAGES :
TABLE : messages
2020-08-31 23:08:26 +02:00
PROVIDERS :
RAPIDS :
COMPUTE : False
2020-11-26 01:42:11 +01:00
MESSAGES_TYPES : [ received, sent]
FEATURES :
received : [ count, distinctcontacts, timefirstmessage, timelastmessage, countmostfrequentcontact]
sent : [ count, distinctcontacts, timefirstmessage, timelastmessage, countmostfrequentcontact]
2020-08-31 23:08:26 +02:00
SRC_LANGUAGE : "r"
2020-11-26 01:42:11 +01:00
SRC_FOLDER : "rapids" # inside src/features/phone_messages
2020-08-31 23:08:26 +02:00
2020-11-26 01:42:11 +01:00
# See https://www.rapids.science/latest/features/phone-screen/
2020-10-19 21:07:12 +02:00
PHONE_SCREEN :
2020-10-21 01:12:01 +02:00
TABLE : screen
2020-09-19 02:25:29 +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" ]
2020-10-19 21:07:12 +02:00
SRC_FOLDER : "rapids" # inside src/features/phone_screen
2020-09-19 02:25:29 +02:00
SRC_LANGUAGE : "python"
2020-01-14 15:51:39 +01:00
2020-11-26 01:42:11 +01:00
# See https://www.rapids.science/latest/features/phone-wifi-connected/
PHONE_WIFI_CONNECTED :
TABLE : "sensor_wifi"
2020-09-01 21:25:35 +02:00
PROVIDERS :
RAPIDS :
2020-09-03 20:36:42 +02:00
COMPUTE : False
2020-11-26 01:42:11 +01:00
FEATURES : [ "countscans" , "uniquedevices" , "countscansmostuniquedevice" ]
SRC_FOLDER : "rapids" # inside src/features/phone_wifi_connected
SRC_LANGUAGE : "r"
2020-02-07 17:52:55 +01:00
2020-11-26 01:42:11 +01:00
# See https://www.rapids.science/latest/features/phone-wifi-visible/
2020-10-19 21:07:12 +02:00
PHONE_WIFI_VISIBLE :
2020-10-21 01:12:01 +02:00
TABLE : "wifi"
2020-10-19 21:07:12 +02:00
PROVIDERS :
RAPIDS :
COMPUTE : False
FEATURES : [ "countscans" , "uniquedevices" , "countscansmostuniquedevice" ]
SRC_FOLDER : "rapids" # inside src/features/phone_wifi_visible
SRC_LANGUAGE : "r"
2020-11-26 01:42:11 +01:00
########################################################################################################################
# FITBIT #
########################################################################################################################
# See https://www.rapids.science/latest/setup/configuration/#device-data-source-configuration
FITBIT_DATA_CONFIGURATION :
SOURCE :
TYPE : DATABASE # DATABASE or FILES (set each [FITBIT_SENSOR][TABLE] attribute with a table name or a file path accordingly)
COLUMN_FORMAT : JSON # JSON or PLAIN_TEXT
DATABASE_GROUP : *database_group
DEVICE_ID_COLUMN : device_id # column name
TIMEZONE :
TYPE : SINGLE # Fitbit devices don't support time zones so we read this data in the timezone indicated by VALUE
VALUE : *timezone
# Sensors ------
2021-02-03 00:30:21 +01:00
# See https://www.rapids.science/latest/features/fitbit-data-yield/
FITBIT_DATA_YIELD :
SENSOR : FITBIT_HEARTRATE_INTRADAY
PROVIDERS :
RAPIDS :
COMPUTE : False
FEATURES : [ ratiovalidyieldedminutes, ratiovalidyieldedhours]
MINUTE_RATIO_THRESHOLD_FOR_VALID_YIELDED_HOURS : 0.5 # 0 to 1 representing the number of minutes with at least
SRC_LANGUAGE : "r"
SRC_FOLDER : "rapids" # inside src/features/fitbit_data_yield
2020-11-26 01:42:11 +01:00
# See https://www.rapids.science/latest/features/fitbit-heartrate-summary/
2020-11-11 23:27:46 +01:00
FITBIT_HEARTRATE_SUMMARY :
TABLE : heartrate_summary
2020-10-21 01:12:01 +02:00
PROVIDERS :
RAPIDS :
2020-10-22 19:08:52 +02:00
COMPUTE : False
2020-11-11 23:27:46 +01:00
FEATURES : [ "maxrestinghr" , "minrestinghr" , "avgrestinghr" , "medianrestinghr" , "moderestinghr" , "stdrestinghr" , "diffmaxmoderestinghr" , "diffminmoderestinghr" , "entropyrestinghr" ] # 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" ]
SRC_FOLDER : "rapids" # inside src/features/fitbit_heartrate_summary
SRC_LANGUAGE : "python"
2020-11-26 01:42:11 +01:00
# See https://www.rapids.science/latest/features/fitbit-heartrate-intraday/
2020-11-11 23:27:46 +01:00
FITBIT_HEARTRATE_INTRADAY :
TABLE : heartrate_intraday
PROVIDERS :
RAPIDS :
COMPUTE : False
FEATURES : [ "maxhr" , "minhr" , "avghr" , "medianhr" , "modehr" , "stdhr" , "diffmaxmodehr" , "diffminmodehr" , "entropyhr" , "minutesonoutofrangezone" , "minutesonfatburnzone" , "minutesoncardiozone" , "minutesonpeakzone" ]
SRC_FOLDER : "rapids" # inside src/features/fitbit_heartrate_intraday
2020-10-27 22:55:57 +01:00
SRC_LANGUAGE : "python"
2020-02-07 17:35:15 +01:00
2020-11-26 01:42:11 +01:00
# See https://www.rapids.science/latest/features/fitbit-sleep-summary/
FITBIT_SLEEP_SUMMARY :
TABLE : sleep_summary
SLEEP_EPISODE_TIMESTAMP : end # summary sleep episodes are considered as events based on either the start timestamp or end timestamp.
PROVIDERS :
RAPIDS :
COMPUTE : False
FEATURES : [ "countepisode" , "avgefficiency" , "sumdurationafterwakeup" , "sumdurationasleep" , "sumdurationawake" , "sumdurationtofallasleep" , "sumdurationinbed" , "avgdurationafterwakeup" , "avgdurationasleep" , "avgdurationawake" , "avgdurationtofallasleep" , "avgdurationinbed" ]
SLEEP_TYPES : [ "main" , "nap" , "all" ]
SRC_FOLDER : "rapids" # inside src/features/fitbit_sleep_summary
SRC_LANGUAGE : "python"
# See https://www.rapids.science/latest/features/fitbit-steps-summary/
2020-11-12 03:16:48 +01:00
FITBIT_STEPS_SUMMARY :
TABLE : steps_summary
PROVIDERS :
RAPIDS :
COMPUTE : False
FEATURES : [ "maxsumsteps" , "minsumsteps" , "avgsumsteps" , "mediansumsteps" , "stdsumsteps" ]
SRC_FOLDER : "rapids" # inside src/features/fitbit_steps_summary
SRC_LANGUAGE : "python"
2020-11-26 01:42:11 +01:00
# See https://www.rapids.science/latest/features/fitbit-steps-intraday/
2020-11-12 03:16:48 +01:00
FITBIT_STEPS_INTRADAY :
TABLE : steps_intraday
2020-10-21 01:12:01 +02:00
PROVIDERS :
RAPIDS :
2020-10-22 19:08:52 +02:00
COMPUTE : False
2020-10-21 01:12:01 +02:00
FEATURES :
2020-11-12 03:16:48 +01:00
STEPS : [ "sum" , "max" , "min" , "avg" , "std" ]
SEDENTARY_BOUT : [ "countepisode" , "sumduration" , "maxduration" , "minduration" , "avgduration" , "stdduration" ]
ACTIVE_BOUT : [ "countepisode" , "sumduration" , "maxduration" , "minduration" , "avgduration" , "stdduration" ]
2020-10-21 01:12:01 +02:00
THRESHOLD_ACTIVE_BOUT : 10 # steps
INCLUDE_ZERO_STEP_ROWS : False
2020-11-12 03:16:48 +01:00
SRC_FOLDER : "rapids" # inside src/features/fitbit_steps_intraday
2020-10-30 23:57:04 +01:00
SRC_LANGUAGE : "python"
2020-03-09 18:32:14 +01:00
2020-11-26 01:42:11 +01:00
# FITBIT_CALORIES:
# TABLE_FORMAT: JSON # JSON or CSV. If your JSON or CSV data are files change [DEVICE_DATA][FITBIT][SOURCE][TYPE] to FILES
# TABLE:
# JSON: fitbit_calories
# CSV:
# SUMMARY: calories_summary
# INTRADAY: calories_intraday
# PROVIDERS:
# RAPIDS:
# COMPUTE: False
# FEATURES: []
2020-12-15 02:30:34 +01:00
########################################################################################################################
# EMPATICA #
########################################################################################################################
EMPATICA_DATA_CONFIGURATION :
SOURCE :
2020-12-16 00:19:11 +01:00
TYPE : ZIP_FILE
FOLDER : data/external/empatica
2020-12-15 02:30:34 +01:00
TIMEZONE :
TYPE : SINGLE # Fitbit devices don't support time zones so we read this data in the timezone indicated by VALUE
VALUE : *timezone
# Sensors ------
# See https://www.rapids.science/latest/features/fitbit-heartrate-summary/
EMPATICA_ACCELEROMETER :
2021-02-16 00:29:05 +01:00
TABLE : ACC
2020-12-15 02:30:34 +01:00
PROVIDERS :
DBDP :
2021-02-02 23:19:10 +01:00
COMPUTE : False
FEATURES : [ "maxmagnitude" , "minmagnitude" , "avgmagnitude" , "medianmagnitude" , "stdmagnitude" ]
2020-12-15 02:30:34 +01:00
SRC_FOLDER : "dbdp" # inside src/features/empatica_accelerometer
SRC_LANGUAGE : "python"
EMPATICA_HEARTRATE :
2021-02-16 00:29:05 +01:00
TABLE : HR
2020-12-15 02:30:34 +01:00
PROVIDERS :
DBDP :
2021-02-02 23:34:56 +01:00
COMPUTE : False
FEATURES : [ "maxhr" , "minhr" , "avghr" , "medianhr" , "modehr" , "stdhr" , "diffmaxmodehr" , "diffminmodehr" , "entropyhr" ]
2020-12-15 02:30:34 +01:00
SRC_FOLDER : "dbdp" # inside src/features/empatica_heartrate
SRC_LANGUAGE : "python"
EMPATICA_TEMPERATURE :
2021-02-16 00:29:05 +01:00
TABLE : TEMP
2020-12-15 02:30:34 +01:00
PROVIDERS :
DBDP :
2021-02-02 23:34:56 +01:00
COMPUTE : False
2021-02-12 02:56:27 +01:00
FEATURES : [ "maxtemp" , "mintemp" , "avgtemp" , "mediantemp" , "modetemp" , "stdtemp" , "diffmaxmodetemp" , "diffminmodetemp" , "entropytemp" ]
2020-12-15 02:30:34 +01:00
SRC_FOLDER : "dbdp" # inside src/features/empatica_heartrate
SRC_LANGUAGE : "python"
EMPATICA_ELECTRODERMAL_ACTIVITY :
2021-02-16 00:29:05 +01:00
TABLE : EDA
2020-12-15 02:30:34 +01:00
PROVIDERS :
DBDP :
2021-02-02 23:34:56 +01:00
COMPUTE : False
2021-02-12 02:56:27 +01:00
FEATURES : [ "maxeda" , "mineda" , "avgeda" , "medianeda" , "modeeda" , "stdeda" , "diffmaxmodeeda" , "diffminmodeeda" , "entropyeda" ]
2021-02-16 00:29:05 +01:00
SRC_FOLDER : "dbdp" # inside src/features/empatica_electrodermal_activity
2020-12-15 02:30:34 +01:00
SRC_LANGUAGE : "python"
EMPATICA_BLOOD_VOLUME_PULSE :
2021-02-16 00:29:05 +01:00
TABLE : BVP
2020-12-15 02:30:34 +01:00
PROVIDERS :
DBDP :
2021-02-02 23:34:56 +01:00
COMPUTE : False
2021-02-12 02:56:27 +01:00
FEATURES : [ "maxbvp" , "minbvp" , "avgbvp" , "medianbvp" , "modebvp" , "stdbvp" , "diffmaxmodebvp" , "diffminmodebvp" , "entropybvp" ]
2021-02-16 00:29:05 +01:00
SRC_FOLDER : "dbdp" # inside src/features/empatica_blood_volume_pulse
2020-12-15 02:30:34 +01:00
SRC_LANGUAGE : "python"
EMPATICA_INTER_BEAT_INTERVAL :
2021-02-16 00:29:05 +01:00
TABLE : IBI
2020-12-15 02:30:34 +01:00
PROVIDERS :
DBDP :
2021-02-02 23:34:56 +01:00
COMPUTE : False
2021-02-12 02:56:27 +01:00
FEATURES : [ "maxibi" , "minibi" , "avgibi" , "medianibi" , "modeibi" , "stdibi" , "diffmaxmodeibi" , "diffminmodeibi" , "entropyibi" ]
2021-02-16 00:29:05 +01:00
SRC_FOLDER : "dbdp" # inside src/features/inter_beat_interval
2020-12-15 02:30:34 +01:00
SRC_LANGUAGE : "python"
EMPATICA_TAGS :
2021-02-16 00:29:05 +01:00
TABLE : TAGS
PROVIDERS : # None implemented yet
2020-05-15 23:51:00 +02:00
2020-11-26 01:42:11 +01:00
########################################################################################################################
# PLOTS #
########################################################################################################################
2020-10-22 19:08:52 +02:00
2020-12-04 22:49:29 +01:00
# Data quality
2020-12-01 20:21:33 +01:00
HISTOGRAM_PHONE_DATA_YIELD :
PLOT : False
2020-12-04 22:49:29 +01:00
HEATMAP_PHONE_DATA_YIELD_PER_PARTICIPANT_PER_TIME_SEGMENT :
PLOT : False
2020-12-04 03:00:32 +01:00
HEATMAP_SENSORS_PER_MINUTE_PER_TIME_SEGMENT :
2020-07-22 22:47:32 +02:00
PLOT : False
2020-12-04 03:00:32 +01:00
HEATMAP_SENSOR_ROW_COUNT_PER_TIME_SEGMENT :
2020-07-22 22:47:32 +02:00
PLOT : False
2020-12-04 03:00:32 +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-07-22 22:47:32 +02:00
2020-12-04 22:49:29 +01:00
# Features
2020-12-04 03:00:32 +01:00
HEATMAP_FEATURE_CORRELATION_MATRIX :
2020-07-22 22:47:32 +02:00
PLOT : False
2020-12-04 03:00:32 +01:00
MIN_ROWS_RATIO : 0.5
CORR_THRESHOLD : 0.1
CORR_METHOD : "pearson" # choose from {"pearson", "kendall", "spearman"}
2020-07-22 22:47:32 +02:00