Skip to content

Commit

Permalink
update units in jasmine docs (#266)
Browse files Browse the repository at this point in the history
  • Loading branch information
@GeorgeEfstathiadis
GeorgeEfstathiadis authored Oct 29, 2024
1 parent cbc3dca commit dc5e708
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions docs/source/jasmine.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -134,10 +134,10 @@ The summary statistics that are generated are listed below:

| Variable | Type | Description of Variable | Description of What it Measures |
|-----------------------------------------------|--------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Observed duration | Float | The total time when the GPS is on | This variable quantifies the missingness and the uncertainty in all other estimates.|
| Observed duration in day | Float | The total time when the GPS is on from 8AM to 8PM | This variable quantifies the missingness in daytime and the majority of uncertainty in all other estimates.|
| Observed duration at night | Float | The total time when the GPS is on from 8PM to 8AM | This variable quantifies the missingness at night and the minority of uncertainty in all other estimates since the user is most likely at home.|
| Home time | Float | Time spent at home over the course of a day (in hours) | “Home” is the most frequently visited significant location for a person between the hours of 8pm and 8am each day over the course of follow up.|
| Observed duration | Float | The total time when the GPS is on (in hours for daily and minutes for hourly) | This variable quantifies the missingness and the uncertainty in all other estimates.|
| Observed duration in day | Float | The total time when the GPS is on from 8AM to 8PM (in hours for daily) | This variable quantifies the missingness in daytime and the majority of uncertainty in all other estimates.|
| Observed duration at night | Float | The total time when the GPS is on from 8PM to 8AM (in hours for daily) | This variable quantifies the missingness at night and the minority of uncertainty in all other estimates since the user is most likely at home.|
| Home time | Float | Time spent at home over the course of a day (in hours for daily and minutes for hourly) | “Home” is the most frequently visited significant location for a person between the hours of 8pm and 8am each day over the course of follow up.|
| Distance traveled | Float | Total distance travelled over the course of a day (in km) | The sum of lengths of all flights. A flight is defined to be a longest straight-line trip of a particle from one location to another without a directional change or pause. Please find the technical details [here](https://github.com/onnela-lab/forest/wiki/Jasmine-documentation#other-technical-details). |
| Radius of gyration | Float | Average radius that a person travels from their center over the course of a day (in km) | Centroid = the average of each ‘place visited’ (see definition ‘significant location’) over the course of a day, with weights proportional to the amount of time spent in the location. The radius of gyration is calculated using a time-weighted average of the distance between each place and the centroid, where weights are measured in the same way. |
| Maximum diameter | Float | Largest distance between any two places that a person visited in a day (in km) | |
Expand All @@ -146,11 +146,11 @@ The summary statistics that are generated are listed below:
| Total flight time | Float | Total time spent in flight over the course of a day (in hours) | A flight is defined to be a longest straight-line trip of a particle from one location to another without a directional change or pause.
| Average flight length | Float | Average of the length of all flights (straight line movement) that took place over the course of a day (in km) | GPS is converted into a sequence of flights (straight line movement) and pauses (time spent stationary). A flight is defined to be a longest straight-line trip of a particle from one location to another without a directional change or pause. Note that a long flight could be composed of several short flights with different directions, but when calculating the average, it is the mean of those short flights. Please find the technical details [here](https://github.com/onnela-lab/forest/wiki/Jasmine-documentation#other-technical-details).|
| Standard deviation of flight length | Float | Standard deviation of the length of all flights (straight line movement) that took place over the course of a day (in km) | GPS is converted into a sequence of flights (straight line movement) and pauses (time spent stationary). The standard deviation of flights of the day is reported. |
| Average flight duration | Float | Average of the duration of all flights (straight line movement) that took place over the course of a day (in hours) | GPS is converted into a sequence of flights (straight line movement) and pauses (time spent stationary). The average of the duration of flights of the day is reported. |
| Standard deviation of flight duration | Float | Standard deviation of the duration of all flights (straight line movement) that took place over the course of a day (in hours) | GPS is converted into a sequence of flights (straight line movement) and pauses (time spent stationary). The standard deviation of the duration of flights of the day is reported. |
| Total pause time | Float | Total time spent in pause over the course of a day (in hours) | A pause is defined to be a longest time spent stationary without a directional change or flight. |
| Average pause duration | Float | Average of the duration of all pauses that took place over the course of a day (in hour) | We consider that a participant has a pause if the distance that he has moved during a 30-s period is less than `r` m. By default, `r`=10.|
| Standard deviation of pause duration | Float | Standard deviation of the duration of all pauses that took place over the course of a day (in hour) | GPS is converted into a sequence of flights (straight line movement) and pauses (time spent stationary). The standard deviation of duration of pauses over the course of a day is reported. |
| Average flight duration | Float | Average of the duration of all flights (straight line movement) that took place over the course of a day (in hours for daily and minutes for hourly) | GPS is converted into a sequence of flights (straight line movement) and pauses (time spent stationary). The average of the duration of flights of the day is reported. |
| Standard deviation of flight duration | Float | Standard deviation of the duration of all flights (straight line movement) that took place over the course of a day (in hours for daily and minutes for hourly) | GPS is converted into a sequence of flights (straight line movement) and pauses (time spent stationary). The standard deviation of the duration of flights of the day is reported. |
| Total pause time | Float | Total time spent in pause over the course of a day (in hours for daily and minutes for hourly) | A pause is defined to be a longest time spent stationary without a directional change or flight. |
| Average pause duration | Float | Average of the duration of all pauses that took place over the course of a day (in hours for daily and minutes for hourly) | We consider that a participant has a pause if the distance that he has moved during a 30-s period is less than `r` m. By default, `r`=10.|
| Standard deviation of pause duration | Float | Standard deviation of the duration of all pauses that took place over the course of a day (in hours for daily and minutes for hourly) | GPS is converted into a sequence of flights (straight line movement) and pauses (time spent stationary). The standard deviation of duration of pauses over the course of a day is reported. |
| Significant location entropy | Float | Entropy measure based on the proportion of time spent at significant locations over the course of a day | Letting p_i be the proportion of the day spent at significant location I, significant location entropy is calculated as -\sum_{i} p_i*log(p_i), where the sum occurs over all non-zero p_i for that day. |
| Minutes of GPS data missing | Not Available | Number of minutes of GPS data missing over the course of a day | |
| Physical circadian rhythm | Float | A continuous measurement of routine in the interval [0,1] that scores a day with 0 if there was a complete break from routine and 1 if the person followed the exact same routine as have in every other day of follow up | For a detailed description of how this measure is calculated, see Canzian and Musolesi's 2015 paper in the Proceedings of the 2015 ACM International Joint Conference on Pervasive and Ubiquitous Computing, titled "Trajectories of depression: unobtrusive monitoring of depressive states by means of smartphone mobility traces analysis." Their procedure was followed using 30-min increments as a bin size.|
Expand Down

0 comments on commit dc5e708

Please sign in to comment.