From 77c27f63680a0691ffc61e0291c6d052f08c002a Mon Sep 17 00:00:00 2001 From: JulioV Date: Thu, 12 Nov 2020 17:35:57 -0500 Subject: [PATCH] Fix event day segments docs --- docs/setup/configuration.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/setup/configuration.md b/docs/setup/configuration.md index 88ac99a1..7f5dcca9 100644 --- a/docs/setup/configuration.md +++ b/docs/setup/configuration.md @@ -288,11 +288,12 @@ Day segments (or epochs) are the time windows on which you want to extract behav | Column | Description | |---------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| - | label | A string that is used as a prefix in the name of your day segments. If labels are unique is segment is completely independent, if two segments have the same label their data will be considered together when computing features like the `most frequent contact` for calls (the most frequent contact will be computed across these segments) | - | start_time | A string with format HH:MM:SS representing the starting time of this segment | - | length | A string representing the length of this segment.It can have one or more of the following `XXD XXH XXM XXS` to represent days, hours, minutes and seconds. For example `7D 23H 59M 59S | - | repeats_on | One of the follow options `every_day`, `wday`, `qday`, `mday`, and `yday`. The last four represent a week, quarter, month and year day | - | repeats_value | An integer complementing `repeats_on`. If `every_day` set this to 0, otherwise 1-7 represent a `wday` starting from Mondays, 1-31 represent a `mday`, 1-91 represent a `qday`, and `1-366` represent a `yday` | + | label | A string that is used as a prefix in the name of your day segments. If labels are unique, every segment is independent; if two or more segments have the same label, their data will be grouped when computing features like the `most frequent contact` for calls (the most frequent contact will be computed across all these segments) | + | event_timestamp | A UNIX timestamp that represents the moment an event of interest happened (clinical relapse, survey, readmission, etc.). The corresponding day segment will be computed around this moment using `length`, `shift`, and `shift_direction` | + | length | A string representing the length of this segment. It can have one or more of the following keys `XXD XXH XXM XXS` to represent a number of days, hours, minutes, and seconds. For example `7D 23H 59M 59S` | + | shift | A string representing the time shift from `event_timestamp`. It can have one or more of the following keys `XXD XXH XXM XXS` to represent a number of days, hours, minutes and seconds. For example `7D 23H 59M 59S`. Use this value to change the start of a segment with respect to its `event_timestamp`. For example, set this variable to `1H` to create a segment that starts 1 hour from an event of interest (`shift_direction` determines if it's before or after). | + | shift_direction | An integer representing whether the `shift` is before (`-1`) or after (`1`) an `event_timestamp` | + |device_id| The device id (smartphone or fitbit) to whom this segment belongs to. You have to create a line in the event segment file for each event of a participant that you want to analyse| !!! example ```csv