junos
/
rapids
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
rapids/docs/features/fitbit-heartrate-summary.md

8.0 KiB
Raw Blame History

Fitbit Heart Rate Summary

Sensor parameters description for [FITBIT_HEARTRATE_SUMMARY]:

Key                              Description
[TABLE] Database table name or file path where the heart rate summary data is stored. The configuration keys in Device Data Source Configuration control whether this parameter is interpreted as table or file.

The format of the column(s) containing the Fitbit sensor data can be JSON or PLAIN_TEXT. The data in JSON format is obtained directly from the Fitbit API. We support PLAIN_TEXT in case you already parsed your data and don't have access to your participants' Fitbit accounts anymore. If your data is in JSON format then summary and intraday data come packed together.

We provide examples of the input format that RAPIDS expects, note that both examples for JSON and PLAIN_TEXT are tabular and the actual format difference comes in the fitbit_data column (we truncate the JSON example for brevity).

??? example "Example of the structure of source data"

=== "JSON"

    |device_id                                |fitbit_data                                               |
    |---------------------------------------- |--------------------------------------------------------- |
    |a748ee1a-1d0b-4ae9-9074-279a2b6ba524     |{"activities-heart":[{"dateTime":"2020-10-07","value":{"customHeartRateZones":[],"heartRateZones":[{"caloriesOut":1200.6102,"max":88,"min":31,"minutes":1058,"name":"Out of Range"},{"caloriesOut":760.3020,"max":120,"min":86,"minutes":366,"name":"Fat Burn"},{"caloriesOut":15.2048,"max":146,"min":120,"minutes":2,"name":"Cardio"},{"caloriesOut":0,"max":221,"min":148,"minutes":0,"name":"Peak"}],"restingHeartRate":72}}],"activities-heart-intraday":{"dataset":[{"time":"00:00:00","value":68},{"time":"00:01:00","value":67},{"time":"00:02:00","value":67},...],"datasetInterval":1,"datasetType":"minute"}}
    |a748ee1a-1d0b-4ae9-9074-279a2b6ba524     |{"activities-heart":[{"dateTime":"2020-10-08","value":{"customHeartRateZones":[],"heartRateZones":[{"caloriesOut":1100.1120,"max":89,"min":30,"minutes":921,"name":"Out of Range"},{"caloriesOut":660.0012,"max":118,"min":82,"minutes":361,"name":"Fat Burn"},{"caloriesOut":23.7088,"max":142,"min":108,"minutes":3,"name":"Cardio"},{"caloriesOut":0,"max":221,"min":148,"minutes":0,"name":"Peak"}],"restingHeartRate":70}}],"activities-heart-intraday":{"dataset":[{"time":"00:00:00","value":77},{"time":"00:01:00","value":75},{"time":"00:02:00","value":73},...],"datasetInterval":1,"datasetType":"minute"}}
    |a748ee1a-1d0b-4ae9-9074-279a2b6ba524     |{"activities-heart":[{"dateTime":"2020-10-09","value":{"customHeartRateZones":[],"heartRateZones":[{"caloriesOut":750.3615,"max":77,"min":30,"minutes":851,"name":"Out of Range"},{"caloriesOut":734.1516,"max":107,"min":77,"minutes":550,"name":"Fat Burn"},{"caloriesOut":131.8579,"max":130,"min":107,"minutes":29,"name":"Cardio"},{"caloriesOut":0,"max":220,"min":130,"minutes":0,"name":"Peak"}],"restingHeartRate":69}}],"activities-heart-intraday":{"dataset":[{"time":"00:00:00","value":90},{"time":"00:01:00","value":89},{"time":"00:02:00","value":88},...],"datasetInterval":1,"datasetType":"minute"}}

=== "PLAIN_TEXT"

    |device_id                              |local_date_time   |heartrate_daily_restinghr |heartrate_daily_caloriesoutofrange  |heartrate_daily_caloriesfatburn  |heartrate_daily_caloriescardio  |heartrate_daily_caloriespeak   |
    |-------------------------------------- |----------------- |------- |-------------- |------------- |------------ |-------|
    |a748ee1a-1d0b-4ae9-9074-279a2b6ba524   |2020-10-07        |72      |1200.6102      |760.3020      |15.2048      |0      |
    |a748ee1a-1d0b-4ae9-9074-279a2b6ba524   |2020-10-08        |70      |1100.1120      |660.0012      |23.7088      |0      |
    |a748ee1a-1d0b-4ae9-9074-279a2b6ba524   |2020-10-09        |69      |750.3615       |734.1516      |131.8579     |0      |

RAPIDS provider

!!! info "Available day segments" - Only available for segments that span 1 or more complete days (e.g. Jan 1st 00:00 to Jan 3rd 23:59)

!!! info "File Sequence" bash - data/raw/{pid}/fitbit_heartrate_summary_raw.csv - data/raw/{pid}/fitbit_heartrate_summary_parsed.csv - data/raw/{pid}/fitbit_heartrate_summary_parsed_with_datetime.csv - data/interim/{pid}/fitbit_heartrate_summary_features/fitbit_heartrate_summary_{language}_{provider_key}.csv - data/processed/features/{pid}/fitbit_heartrate_summary.csv

Parameters description for [FITBIT_HEARTRATE_SUMMARY][PROVIDERS][RAPIDS]:

Key                              Description
[COMPUTE] Set to True to extract FITBIT_HEARTRATE_SUMMARY features from the RAPIDS provider
[FEATURES] Features to be computed from heart rate summary data, see table below

Features description for [FITBIT_HEARTRATE_SUMMARY][PROVIDERS][RAPIDS]:

Feature Units Description
maxrestinghr beats/mins The maximum daily resting heart rate during a day segment.
minrestinghr beats/mins The minimum daily resting heart rate during a day segment.
avgrestinghr beats/mins The average daily resting heart rate during a day segment.
medianrestinghr beats/mins The median of daily resting heart rate during a day segment.
moderestinghr beats/mins The mode of daily resting heart rate during a day segment.
stdrestinghr beats/mins The standard deviation of daily resting heart rate during a day segment.
diffmaxmoderestinghr beats/mins The difference between the maximum and mode daily resting heart rate during a day segment.
diffminmoderestinghr beats/mins The difference between the mode and minimum daily resting heart rate during a day segment.
entropyrestinghr nats Shannon’s entropy measurement based on daily resting heart rate during a day segment.
sumcaloriesZONE cals The total daily calories burned within heartrate_zone during a day segment.
maxcaloriesZONE cals The maximum daily calories burned within heartrate_zone during a day segment.
mincaloriesZONE cals The minimum daily calories burned within heartrate_zone during a day segment.
avgcaloriesZONE cals The average daily calories burned within heartrate_zone during a day segment.
mediancaloriesZONE cals The median of daily calories burned within heartrate_zone during a day segment.
stdcaloriesZONE cals The standard deviation of daily calories burned within heartrate_zone during a day segment.
entropycaloriesZONE nats Shannon’s entropy measurement based on daily calories burned within heartrate_zone during a day segment.

!!! note "Assumptions/Observations"

1. There are four heart rate zones (ZONE): ``outofrange``, ``fatburn``, ``cardio``, and ``peak``. Please refer to [Fitbit documentation](https://help.fitbit.com/articles/en_US/Help_article/1565.htm) for more information about the way they are computed.

2. Calories' accuracy depends on the users’ Fitbit profile (weight, height, etc.).