Deployed 00a3335 to 1.0 with MkDocs 1.1.2 and mike 0.5.5

gh-pages
github-actions 2021-04-08 20:33:04 +00:00
parent 0a8c89662b
commit d08406714d
10 changed files with 212 additions and 150 deletions

View File

@ -1678,6 +1678,13 @@
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#v101" class="md-nav__link">
v1.0.1
</a>
</li>
<li class="md-nav__item">
<a href="#v100" class="md-nav__link">
v1.0.0
@ -1829,6 +1836,13 @@
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#v101" class="md-nav__link">
v1.0.1
</a>
</li>
<li class="md-nav__item">
<a href="#v100" class="md-nav__link">
v1.0.0
@ -1959,6 +1973,16 @@
<h1 id="change-log">Change Log<a class="headerlink" href="#change-log" title="Permanent link">&para;</a></h1>
<h2 id="v101">v1.0.1<a class="headerlink" href="#v101" title="Permanent link">&para;</a></h2>
<ul>
<li>Fix crash in <code>chunk_episodes</code> of <code>utils.py</code> for multi time zone data</li>
<li>Fix crash in BT Doryab provider when the number of clusters is 2</li>
<li>Fix Fitbit multi time zone inference from phone data (simplify)</li>
<li>Fix missing columns when the input for phone data yield is empty</li>
<li>Fix wrong date time labels for event segments for multi time zone data (all labels are computed based on a single tz)</li>
<li>Fix periodic segment crash when there are no segments to assign (only affects wday, mday, qday, or yday) </li>
<li>Fix crash in Analysis Workflow with new suffix in segments&rsquo; labels</li>
</ul>
<h2 id="v100">v1.0.0<a class="headerlink" href="#v100" title="Permanent link">&para;</a></h2>
<ul>
<li>Add a new <a href="../setup/overview/">Overview</a> page.</li>

File diff suppressed because one or more lines are too long

View File

@ -1986,7 +1986,7 @@
<tbody>
<tr>
<td><code>[DEVICE_IDS]</code></td>
<td>An array of the strings that uniquely identify each smartphone, you can have more than one for when participants changed phones in the middle of the study, in this case, data from all their devices will be joined and relabeled with the last 1 on this list.</td>
<td>An array of the strings that uniquely identify each smartphone, you can have more than one for when participants changed phones in the middle of the study.</td>
</tr>
<tr>
<td><code>[PLATFORMS]</code></td>
@ -2018,7 +2018,7 @@
<tbody>
<tr>
<td><code>[DEVICE_IDS]</code></td>
<td>An array of the strings that uniquely identify each Fitbit, you can have more than one in case the participant changed devices in the middle of the study, in this case, data from all devices will be joined and relabeled with the last <code>device_id</code> on this list.</td>
<td>An array of the strings that uniquely identify each Fitbit, you can have more than one in case the participant changed devices in the middle of the study.</td>
</tr>
<tr>
<td><code>[LABEL]</code></td>
@ -2293,6 +2293,13 @@ mood,1587906020000,7D,0,0,a748ee1a-1d0b-4ae9-9074-279a2b6ba524
<p>This example will create eight segments for a single participant (<code>a748ee1a...</code>), five independent <code>stressX</code> segments with various lengths (1,4,3,7, and 9 hours). Segments <code>stress1</code>, <code>stress3</code>, and <code>stress5</code> are shifted forwards by 5 minutes and <code>stress2</code> and <code>stress4</code> are shifted backwards by 4 hours (that is, if the <code>stress4</code> event happened on March 15<sup>th</sup> at 1pm EST (<code>1584291600000</code>), the time segment will start on that day at 9am and end at 4pm). </p>
<p>The three <code>mood</code> segments are 1 hour, 1 day and 7 days long and have no shift. In addition, these <code>mood</code> segments are grouped together, meaning that although RAPIDS will compute features on each one of them, some necessary information to compute a few of such features will be extracted from all three segments, for example the phone contact that called a participant the most or the location clusters visited by a participant.</p>
</div>
<details class="info"><summary>Date time labels of event segments</summary><p>In the final feature file, you will find a row per event segment. The <code>local_segment</code> column of each row has a <code>label</code>, a start date-time string, and an end date-time string.</p>
<div class="highlight"><pre><span></span><code>weeklysurvey2060#2020-09-12 <span class="m">01</span>:00:00,2020-09-18 <span class="m">23</span>:59:59
</code></pre></div>
<p>All sensor data is always segmented based on timestamps, and the date-time strings are attached for informative purposes. For example, you can plot your features based on these strings. </p>
<p>When you configure RAPIDS to work with a single time zone, such tz code will be used to convert start/end timestamps (the ones you typed in the event segments file) into start/end date-time strings. However, when you configure RAPIDS to work with multiple time zones, RAPIDS will use the most common time zone across all devices of every participant to do the conversion. The most common time zone is the one in which a participant spent the most time.</p>
<p>In practical terms, this means that the date-time strings of event segments that happened in uncommon time zones will have shifted start/end date-time labels. However, the data within each segment was correctly filtered based on timestamps.</p>
</details>
</div>
</div>
<h3 id="segment-examples">Segment Examples<a class="headerlink" href="#segment-examples" title="Permanent link">&para;</a></h3>
@ -2357,7 +2364,7 @@ survey2,1584291600000,2H,1H,-1,klj34oi2-8frk-2343-21kk-324ljklewlr3
<span class="nt">TZCODE</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">America/New_York</span>
</code></pre></div>
<h3 id="multiple-timezones">Multiple timezones<a class="headerlink" href="#multiple-timezones" title="Permanent link">&para;</a></h3>
<p>If your participants lived on different time zones or they travelled across time zones, and you know when participants&rsquo; devices were in a specific time zone, RAPIDS can use this data to process your data streams with the correct date-time. You need to provide RAPIDS with the time zone data in a CSV file (<code>[TZCODES_FILE]</code>) in the format described below.</p>
<p>If your participants lived in different time zones or they traveled across time zones, and you know when participants&rsquo; devices were in a specific time zone, RAPIDS can use this data to process your data streams with the correct date-time. You need to provide RAPIDS with the time zone data in a CSV file (<code>[TZCODES_FILE]</code>) in the format described below.</p>
<div class="highlight"><pre><span></span><code><span class="nt">TIMEZONE</span><span class="p">:</span>
<span class="nt">TYPE</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">MULTIPLE</span>
<span class="nt">SINGLE</span><span class="p">:</span>
@ -2389,7 +2396,7 @@ survey2,1584291600000,2H,1H,-1,klj34oi2-8frk-2343-21kk-324ljklewlr3
</tr>
<tr>
<td><code>[MULTIPLE][TZCODES_FILE]</code></td>
<td>A CSV file containing the time and code from this <a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones">list</a> visited by each device in the study. Multiple devices can be linked to the same person, read more in <a href="#participant-files">Participants Files</a></td>
<td>A CSV file containing the time zones in which participants&rsquo; devices sensed data (see the required format below). Multiple devices can be linked to the same person, read more in <a href="#participant-files">Participants Files</a></td>
</tr>
<tr>
<td><code>[MULTIPLE][IF_MISSING_TZCODE]</code></td>
@ -2448,7 +2455,7 @@ survey2,1584291600000,2H,1H,-1,klj34oi2-8frk-2343-21kk-324ljklewlr3
<li>A screen row sensed at <code>1587400000000</code> will be discarded because it was logged outside any interval.</li>
</ul>
</details>
<details class="note"><summary>Can I get the <code>TZCODES_FILE</code> from the time zone table collected automatically by the AWARE app?</summary><p>Sure. You can put your timezone table (<code>timezone.csv</code>) collected by AWARE app under <code>data/external</code> folder and run:
<details class="note"><summary>Can I get the <code>TZCODES_FILE</code> from the time zone table collected automatically by the AWARE app?</summary><p>Sure. You can put your timezone table (<code>timezone.csv</code>) collected by the AWARE app under <code>data/external</code> folder and run:
<div class="highlight"><pre><span></span><code>python tools/create_multi_timezones_file.py
</code></pre></div>
The <code>TZCODES_FILE</code> will be saved as <code>data/external/multiple_timezones.csv</code> file.</p>

View File

@ -1,279 +1,279 @@
<?xml version="1.0" encoding="UTF-8"?>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"><url>
<loc>https://www.rapids.science/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/setup/overview/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/workflow-examples/minimal/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/setup/installation/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/setup/configuration/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/setup/execution/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/citation/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/datastreams/data-streams-introduction/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/datastreams/aware-mysql/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/datastreams/aware-csv/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/datastreams/aware-influxdb/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/datastreams/mandatory-phone-format/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/datastreams/fitbitjson-mysql/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/datastreams/fitbitjson-csv/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/datastreams/fitbitparsed-mysql/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/datastreams/fitbitparsed-csv/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/datastreams/mandatory-fitbit-format/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/datastreams/empatica-zip/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/datastreams/mandatory-empatica-format/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/datastreams/add-new-data-streams/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/feature-introduction/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/phone-accelerometer/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/phone-activity-recognition/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/phone-applications-crashes/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/phone-applications-foreground/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/phone-applications-notifications/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/phone-battery/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/phone-bluetooth/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/phone-calls/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/phone-conversation/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/phone-data-yield/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/phone-keyboard/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/phone-light/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/phone-locations/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/phone-log/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/phone-messages/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/phone-screen/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/phone-wifi-connected/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/phone-wifi-visible/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/fitbit-data-yield/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/fitbit-heartrate-summary/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/fitbit-heartrate-intraday/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/fitbit-sleep-summary/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/fitbit-sleep-intraday/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/fitbit-steps-summary/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/fitbit-steps-intraday/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/empatica-accelerometer/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/empatica-heartrate/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/empatica-temperature/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/empatica-electrodermal-activity/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/empatica-blood-volume-pulse/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/empatica-inter-beat-interval/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/empatica-tags/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/add-new-features/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/visualizations/data-quality-visualizations/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/visualizations/feature-visualizations/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/workflow-examples/analysis/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/developers/git-flow/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/developers/remote-support/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/developers/virtual-environments/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/developers/documentation/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/developers/testing/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/developers/test-cases/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/developers/validation-schema-config/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/migrating-from-old-versions/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/code_of_conduct/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/common-errors/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/team/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/change-log/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url>
</urlset>

Binary file not shown.

View File

@ -1678,6 +1678,13 @@
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#v101" class="md-nav__link">
v1.0.1
</a>
</li>
<li class="md-nav__item">
<a href="#v100" class="md-nav__link">
v1.0.0
@ -1829,6 +1836,13 @@
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#v101" class="md-nav__link">
v1.0.1
</a>
</li>
<li class="md-nav__item">
<a href="#v100" class="md-nav__link">
v1.0.0
@ -1959,6 +1973,16 @@
<h1 id="change-log">Change Log<a class="headerlink" href="#change-log" title="Permanent link">&para;</a></h1>
<h2 id="v101">v1.0.1<a class="headerlink" href="#v101" title="Permanent link">&para;</a></h2>
<ul>
<li>Fix crash in <code>chunk_episodes</code> of <code>utils.py</code> for multi time zone data</li>
<li>Fix crash in BT Doryab provider when the number of clusters is 2</li>
<li>Fix Fitbit multi time zone inference from phone data (simplify)</li>
<li>Fix missing columns when the input for phone data yield is empty</li>
<li>Fix wrong date time labels for event segments for multi time zone data (all labels are computed based on a single tz)</li>
<li>Fix periodic segment crash when there are no segments to assign (only affects wday, mday, qday, or yday) </li>
<li>Fix crash in Analysis Workflow with new suffix in segments&rsquo; labels</li>
</ul>
<h2 id="v100">v1.0.0<a class="headerlink" href="#v100" title="Permanent link">&para;</a></h2>
<ul>
<li>Add a new <a href="../setup/overview/">Overview</a> page.</li>

File diff suppressed because one or more lines are too long

View File

@ -1986,7 +1986,7 @@
<tbody>
<tr>
<td><code>[DEVICE_IDS]</code></td>
<td>An array of the strings that uniquely identify each smartphone, you can have more than one for when participants changed phones in the middle of the study, in this case, data from all their devices will be joined and relabeled with the last 1 on this list.</td>
<td>An array of the strings that uniquely identify each smartphone, you can have more than one for when participants changed phones in the middle of the study.</td>
</tr>
<tr>
<td><code>[PLATFORMS]</code></td>
@ -2018,7 +2018,7 @@
<tbody>
<tr>
<td><code>[DEVICE_IDS]</code></td>
<td>An array of the strings that uniquely identify each Fitbit, you can have more than one in case the participant changed devices in the middle of the study, in this case, data from all devices will be joined and relabeled with the last <code>device_id</code> on this list.</td>
<td>An array of the strings that uniquely identify each Fitbit, you can have more than one in case the participant changed devices in the middle of the study.</td>
</tr>
<tr>
<td><code>[LABEL]</code></td>
@ -2293,6 +2293,13 @@ mood,1587906020000,7D,0,0,a748ee1a-1d0b-4ae9-9074-279a2b6ba524
<p>This example will create eight segments for a single participant (<code>a748ee1a...</code>), five independent <code>stressX</code> segments with various lengths (1,4,3,7, and 9 hours). Segments <code>stress1</code>, <code>stress3</code>, and <code>stress5</code> are shifted forwards by 5 minutes and <code>stress2</code> and <code>stress4</code> are shifted backwards by 4 hours (that is, if the <code>stress4</code> event happened on March 15<sup>th</sup> at 1pm EST (<code>1584291600000</code>), the time segment will start on that day at 9am and end at 4pm). </p>
<p>The three <code>mood</code> segments are 1 hour, 1 day and 7 days long and have no shift. In addition, these <code>mood</code> segments are grouped together, meaning that although RAPIDS will compute features on each one of them, some necessary information to compute a few of such features will be extracted from all three segments, for example the phone contact that called a participant the most or the location clusters visited by a participant.</p>
</div>
<details class="info"><summary>Date time labels of event segments</summary><p>In the final feature file, you will find a row per event segment. The <code>local_segment</code> column of each row has a <code>label</code>, a start date-time string, and an end date-time string.</p>
<div class="highlight"><pre><span></span><code>weeklysurvey2060#2020-09-12 <span class="m">01</span>:00:00,2020-09-18 <span class="m">23</span>:59:59
</code></pre></div>
<p>All sensor data is always segmented based on timestamps, and the date-time strings are attached for informative purposes. For example, you can plot your features based on these strings. </p>
<p>When you configure RAPIDS to work with a single time zone, such tz code will be used to convert start/end timestamps (the ones you typed in the event segments file) into start/end date-time strings. However, when you configure RAPIDS to work with multiple time zones, RAPIDS will use the most common time zone across all devices of every participant to do the conversion. The most common time zone is the one in which a participant spent the most time.</p>
<p>In practical terms, this means that the date-time strings of event segments that happened in uncommon time zones will have shifted start/end date-time labels. However, the data within each segment was correctly filtered based on timestamps.</p>
</details>
</div>
</div>
<h3 id="segment-examples">Segment Examples<a class="headerlink" href="#segment-examples" title="Permanent link">&para;</a></h3>
@ -2357,7 +2364,7 @@ survey2,1584291600000,2H,1H,-1,klj34oi2-8frk-2343-21kk-324ljklewlr3
<span class="nt">TZCODE</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">America/New_York</span>
</code></pre></div>
<h3 id="multiple-timezones">Multiple timezones<a class="headerlink" href="#multiple-timezones" title="Permanent link">&para;</a></h3>
<p>If your participants lived on different time zones or they travelled across time zones, and you know when participants&rsquo; devices were in a specific time zone, RAPIDS can use this data to process your data streams with the correct date-time. You need to provide RAPIDS with the time zone data in a CSV file (<code>[TZCODES_FILE]</code>) in the format described below.</p>
<p>If your participants lived in different time zones or they traveled across time zones, and you know when participants&rsquo; devices were in a specific time zone, RAPIDS can use this data to process your data streams with the correct date-time. You need to provide RAPIDS with the time zone data in a CSV file (<code>[TZCODES_FILE]</code>) in the format described below.</p>
<div class="highlight"><pre><span></span><code><span class="nt">TIMEZONE</span><span class="p">:</span>
<span class="nt">TYPE</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">MULTIPLE</span>
<span class="nt">SINGLE</span><span class="p">:</span>
@ -2389,7 +2396,7 @@ survey2,1584291600000,2H,1H,-1,klj34oi2-8frk-2343-21kk-324ljklewlr3
</tr>
<tr>
<td><code>[MULTIPLE][TZCODES_FILE]</code></td>
<td>A CSV file containing the time and code from this <a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones">list</a> visited by each device in the study. Multiple devices can be linked to the same person, read more in <a href="#participant-files">Participants Files</a></td>
<td>A CSV file containing the time zones in which participants&rsquo; devices sensed data (see the required format below). Multiple devices can be linked to the same person, read more in <a href="#participant-files">Participants Files</a></td>
</tr>
<tr>
<td><code>[MULTIPLE][IF_MISSING_TZCODE]</code></td>
@ -2448,7 +2455,7 @@ survey2,1584291600000,2H,1H,-1,klj34oi2-8frk-2343-21kk-324ljklewlr3
<li>A screen row sensed at <code>1587400000000</code> will be discarded because it was logged outside any interval.</li>
</ul>
</details>
<details class="note"><summary>Can I get the <code>TZCODES_FILE</code> from the time zone table collected automatically by the AWARE app?</summary><p>Sure. You can put your timezone table (<code>timezone.csv</code>) collected by AWARE app under <code>data/external</code> folder and run:
<details class="note"><summary>Can I get the <code>TZCODES_FILE</code> from the time zone table collected automatically by the AWARE app?</summary><p>Sure. You can put your timezone table (<code>timezone.csv</code>) collected by the AWARE app under <code>data/external</code> folder and run:
<div class="highlight"><pre><span></span><code>python tools/create_multi_timezones_file.py
</code></pre></div>
The <code>TZCODES_FILE</code> will be saved as <code>data/external/multiple_timezones.csv</code> file.</p>

View File

@ -1,279 +1,279 @@
<?xml version="1.0" encoding="UTF-8"?>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"><url>
<loc>https://www.rapids.science/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/setup/overview/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/workflow-examples/minimal/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/setup/installation/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/setup/configuration/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/setup/execution/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/citation/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/datastreams/data-streams-introduction/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/datastreams/aware-mysql/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/datastreams/aware-csv/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/datastreams/aware-influxdb/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/datastreams/mandatory-phone-format/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/datastreams/fitbitjson-mysql/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/datastreams/fitbitjson-csv/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/datastreams/fitbitparsed-mysql/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/datastreams/fitbitparsed-csv/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/datastreams/mandatory-fitbit-format/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/datastreams/empatica-zip/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/datastreams/mandatory-empatica-format/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/datastreams/add-new-data-streams/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/feature-introduction/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/phone-accelerometer/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/phone-activity-recognition/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/phone-applications-crashes/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/phone-applications-foreground/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/phone-applications-notifications/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/phone-battery/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/phone-bluetooth/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/phone-calls/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/phone-conversation/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/phone-data-yield/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/phone-keyboard/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/phone-light/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/phone-locations/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/phone-log/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/phone-messages/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/phone-screen/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/phone-wifi-connected/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/phone-wifi-visible/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/fitbit-data-yield/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/fitbit-heartrate-summary/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/fitbit-heartrate-intraday/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/fitbit-sleep-summary/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/fitbit-sleep-intraday/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/fitbit-steps-summary/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/fitbit-steps-intraday/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/empatica-accelerometer/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/empatica-heartrate/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/empatica-temperature/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/empatica-electrodermal-activity/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/empatica-blood-volume-pulse/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/empatica-inter-beat-interval/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/empatica-tags/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/features/add-new-features/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/visualizations/data-quality-visualizations/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/visualizations/feature-visualizations/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/workflow-examples/analysis/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/developers/git-flow/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/developers/remote-support/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/developers/virtual-environments/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/developers/documentation/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/developers/testing/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/developers/test-cases/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/developers/validation-schema-config/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/migrating-from-old-versions/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/code_of_conduct/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/common-errors/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/team/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>https://www.rapids.science/change-log/</loc>
<lastmod>2021-03-30</lastmod>
<lastmod>2021-04-08</lastmod>
<changefreq>daily</changefreq>
</url>
</urlset>

Binary file not shown.