Deployed 5f51c94 to 0.1 with MkDocs 1.1.2 and mike 0.5.5

pull/106/head
github-actions 2020-11-26 00:43:05 +00:00
parent 790836c14a
commit 1db1060fa4
78 changed files with 1126 additions and 1222 deletions

View File

@ -402,18 +402,6 @@
<li class="md-nav__item">
<a href="/features/phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="/features/phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -498,6 +486,18 @@
<li class="md-nav__item">
<a href="/features/phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="/features/phone-light/" class="md-nav__link">
Phone Light

View File

@ -407,18 +407,6 @@
<li class="md-nav__item">
<a href="../features/phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../features/phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -503,6 +491,18 @@
<li class="md-nav__item">
<a href="../features/phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../features/phone-light/" class="md-nav__link">
Phone Light

View File

@ -407,18 +407,6 @@
<li class="md-nav__item">
<a href="../../features/phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../../features/phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -503,6 +491,18 @@
<li class="md-nav__item">
<a href="../../features/phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../../features/phone-light/" class="md-nav__link">
Phone Light

View File

@ -407,18 +407,6 @@
<li class="md-nav__item">
<a href="../../features/phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../../features/phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -503,6 +491,18 @@
<li class="md-nav__item">
<a href="../../features/phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../../features/phone-light/" class="md-nav__link">
Phone Light

View File

@ -407,18 +407,6 @@
<li class="md-nav__item">
<a href="../../features/phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../../features/phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -503,6 +491,18 @@
<li class="md-nav__item">
<a href="../../features/phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../../features/phone-light/" class="md-nav__link">
Phone Light

View File

@ -407,18 +407,6 @@
<li class="md-nav__item">
<a href="../../features/phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../../features/phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -503,6 +491,18 @@
<li class="md-nav__item">
<a href="../../features/phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../../features/phone-light/" class="md-nav__link">
Phone Light

View File

@ -407,18 +407,6 @@
<li class="md-nav__item">
<a href="../../features/phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../../features/phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -503,6 +491,18 @@
<li class="md-nav__item">
<a href="../../features/phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../../features/phone-light/" class="md-nav__link">
Phone Light

View File

@ -407,18 +407,6 @@
<li class="md-nav__item">
<a href="../features/phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../features/phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -503,6 +491,18 @@
<li class="md-nav__item">
<a href="../features/phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../features/phone-light/" class="md-nav__link">
Phone Light

View File

@ -409,18 +409,6 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -505,6 +493,18 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-light/" class="md-nav__link">
Phone Light

View File

@ -474,18 +474,6 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -570,6 +558,18 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-light/" class="md-nav__link">
Phone Light
@ -982,11 +982,11 @@
<p>Every phone or Fitbit sensor has a corresponding config section in <code>config.yaml</code>, these sections follow a similar structure and we&rsquo;ll use <code>PHONE_ACCELEROMETER</code> as an example to explain this structure.</p>
<div class="admonition hint">
<p class="admonition-title">Hint</p>
<p>We recommend reading this page if you are using RAPIDS for the first time</p>
</div>
<div class="admonition hint">
<p class="admonition-title">Hint</p>
<p>All sensor features are stored under <code>/data/processed/features</code> on files per sensor, per participant and per study (all participants).</p>
<ul>
<li>We recommend reading this page if you are using RAPIDS for the first time</li>
<li>All computed sensor features are stored under <code>/data/processed/features</code> on files per sensor, per participant and per study (all participants).</li>
<li>Every time you change any sensor parameters, provider parameters or provider features, all the necessary files will be updated as soon as you execute RAPIDS.</li>
</ul>
</div>
<div class="admonition example">
<p class="admonition-title">Config section example for <code>PHONE_ACCELEROMETER</code></p>
@ -1029,10 +1029,6 @@
<h3 id="provider-features">Provider Features<a class="headerlink" href="#provider-features" title="Permanent link">&para;</a></h3>
<p>Each provider offers a set of behavioral features (see <code>#4.2</code> or <code>#5.2</code> in the example). For some providers these features are grouped in an array (like those for <code>RAPIDS</code> provider in <code>#4.2</code>) but for others they are grouped in a collection of arrays depending on the meaning and purpose of those features (like those for <code>PANDAS</code> provider in <code>#5.2</code>). In either case, you can delete the features you are not interested in and they will not be included in the sensor&rsquo;s output feature file. </p>
<p>We explain each behavioral feature in a table under the <code>Features description</code> heading on each provider documentation page.</p>
<div class="admonition hint">
<p class="admonition-title">Hint</p>
<p>Every time you change any sensor parameters, provider parameters or provider features, all the necessary files will be updated as soon as you execute RAPIDS.</p>
</div>
@ -1066,13 +1062,13 @@
</a>
<a href="../phone-data-yield/" class="md-footer-nav__link md-footer-nav__link--next" rel="next">
<a href="../phone-accelerometer/" class="md-footer-nav__link md-footer-nav__link--next" rel="next">
<div class="md-footer-nav__title">
<div class="md-ellipsis">
<span class="md-footer-nav__direction">
Next
</span>
Phone Data Yield
Phone Accelerometer
</div>
</div>
<div class="md-footer-nav__button md-icon">

View File

@ -409,18 +409,6 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -505,6 +493,18 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-light/" class="md-nav__link">
Phone Light

View File

@ -409,18 +409,6 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -505,6 +493,18 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-light/" class="md-nav__link">
Phone Light

View File

@ -409,18 +409,6 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -505,6 +493,18 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-light/" class="md-nav__link">
Phone Light

View File

@ -409,18 +409,6 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -505,6 +493,18 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-light/" class="md-nav__link">
Phone Light

View File

@ -409,18 +409,6 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -505,6 +493,18 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-light/" class="md-nav__link">
Phone Light

View File

@ -410,18 +410,6 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
@ -552,6 +540,18 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-light/" class="md-nav__link">
Phone Light
@ -1137,7 +1137,7 @@
<div class="md-footer-nav">
<nav class="md-footer-nav__inner md-grid" aria-label="Footer">
<a href="../phone-data-yield/" class="md-footer-nav__link md-footer-nav__link--prev" rel="prev">
<a href="../feature-introduction/" class="md-footer-nav__link md-footer-nav__link--prev" rel="prev">
<div class="md-footer-nav__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
</div>
@ -1146,7 +1146,7 @@
<span class="md-footer-nav__direction">
Previous
</span>
Phone Data Yield
Introduction
</div>
</div>
</a>

View File

@ -411,18 +411,6 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -545,6 +533,18 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-light/" class="md-nav__link">
Phone Light

View File

@ -411,18 +411,6 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -545,6 +533,18 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-light/" class="md-nav__link">
Phone Light

View File

@ -411,18 +411,6 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -545,6 +533,18 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-light/" class="md-nav__link">
Phone Light

View File

@ -411,18 +411,6 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -545,6 +533,18 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-light/" class="md-nav__link">
Phone Light

View File

@ -411,18 +411,6 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -545,6 +533,18 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-light/" class="md-nav__link">
Phone Light

View File

@ -411,18 +411,6 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -545,6 +533,18 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-light/" class="md-nav__link">
Phone Light
@ -1186,13 +1186,13 @@
</a>
<a href="../phone-light/" class="md-footer-nav__link md-footer-nav__link--next" rel="next">
<a href="../phone-data-yield/" class="md-footer-nav__link md-footer-nav__link--next" rel="next">
<div class="md-footer-nav__title">
<div class="md-ellipsis">
<span class="md-footer-nav__direction">
Next
</span>
Phone Light
Phone Data Yield
</div>
</div>
<div class="md-footer-nav__button md-icon">

View File

@ -410,56 +410,6 @@
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
Phone Data Yield
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
Phone Data Yield
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="#rapids-provider" class="md-nav__link">
RAPIDS provider
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../phone-accelerometer/" class="md-nav__link">
@ -544,6 +494,56 @@
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
Phone Data Yield
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
Phone Data Yield
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="#rapids-provider" class="md-nav__link">
RAPIDS provider
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../phone-light/" class="md-nav__link">
@ -1064,7 +1064,7 @@
<div class="md-footer-nav">
<nav class="md-footer-nav__inner md-grid" aria-label="Footer">
<a href="../feature-introduction/" class="md-footer-nav__link md-footer-nav__link--prev" rel="prev">
<a href="../phone-conversation/" class="md-footer-nav__link md-footer-nav__link--prev" rel="prev">
<div class="md-footer-nav__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
</div>
@ -1073,19 +1073,19 @@
<span class="md-footer-nav__direction">
Previous
</span>
Introduction
Phone Conversation
</div>
</div>
</a>
<a href="../phone-accelerometer/" class="md-footer-nav__link md-footer-nav__link--next" rel="next">
<a href="../phone-light/" class="md-footer-nav__link md-footer-nav__link--next" rel="next">
<div class="md-footer-nav__title">
<div class="md-ellipsis">
<span class="md-footer-nav__direction">
Next
</span>
Phone Accelerometer
Phone Light
</div>
</div>
<div class="md-footer-nav__button md-icon">

View File

@ -411,18 +411,6 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -506,6 +494,18 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
@ -1041,7 +1041,7 @@
<div class="md-footer-nav">
<nav class="md-footer-nav__inner md-grid" aria-label="Footer">
<a href="../phone-conversation/" class="md-footer-nav__link md-footer-nav__link--prev" rel="prev">
<a href="../phone-data-yield/" class="md-footer-nav__link md-footer-nav__link--prev" rel="prev">
<div class="md-footer-nav__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
</div>
@ -1050,7 +1050,7 @@
<span class="md-footer-nav__direction">
Previous
</span>
Phone Conversation
Phone Data Yield
</div>
</div>
</a>

View File

@ -411,18 +411,6 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -507,6 +495,18 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-light/" class="md-nav__link">
Phone Light

View File

@ -411,18 +411,6 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -507,6 +495,18 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-light/" class="md-nav__link">
Phone Light

View File

@ -411,18 +411,6 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -507,6 +495,18 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-light/" class="md-nav__link">
Phone Light

View File

@ -411,18 +411,6 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -507,6 +495,18 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-light/" class="md-nav__link">
Phone Light

View File

@ -411,18 +411,6 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -507,6 +495,18 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-light/" class="md-nav__link">
Phone Light

View File

@ -418,18 +418,6 @@
<li class="md-nav__item">
<a href="../features/phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../features/phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -514,6 +502,18 @@
<li class="md-nav__item">
<a href="../features/phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../features/phone-light/" class="md-nav__link">
Phone Light

View File

@ -459,18 +459,6 @@
<li class="md-nav__item">
<a href="features/phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="features/phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -555,6 +543,18 @@
<li class="md-nav__item">
<a href="features/phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="features/phone-light/" class="md-nav__link">
Phone Light

File diff suppressed because one or more lines are too long

View File

@ -535,18 +535,6 @@
<li class="md-nav__item">
<a href="../../features/phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../../features/phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -631,6 +619,18 @@
<li class="md-nav__item">
<a href="../../features/phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../../features/phone-light/" class="md-nav__link">
Phone Light
@ -1488,32 +1488,19 @@ mood,1587906020000,7D,0,0,a748ee1a-1d0b-4ae9-9074-279a2b6ba524
<h3 id="segment-examples">Segment Examples<a class="headerlink" href="#segment-examples" title="Permanent link">&para;</a></h3>
<hr />
<h2 id="device-data-source-configuration">Device Data Source Configuration<a class="headerlink" href="#device-data-source-configuration" title="Permanent link">&para;</a></h2>
<p>You might need to modify the following config keys in your <code>config.yaml</code> depending on what devices your participants used and where you are storing your data.</p>
<div class="admonition hint">
<p class="admonition-title">Hint</p>
<p>You can ignore <code>[DEVICE_DATA][PHONE]</code> or <code>[DEVICE_DATA][FITBIT]</code> if you are not working with either devices.</p>
</div>
<p>The relevant <code>config.yaml</code> section looks as follows by default:</p>
<div class="highlight"><pre><span></span><code><span class="nt">DEVICE_DATA</span><span class="p">:</span>
<span class="nt">PHONE</span><span class="p">:</span>
<span class="nt">SOURCE</span><span class="p">:</span>
<span class="nt">TYPE</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">DATABASE</span>
<span class="nt">DATABASE_GROUP</span><span class="p">:</span> <span class="nv">*database_group</span>
<span class="nt">DEVICE_ID_COLUMN</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">device_id</span> <span class="c1"># column name</span>
<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">SINGLE</span>
<span class="nt">VALUE</span><span class="p">:</span> <span class="nv">*timezone</span>
<span class="nt">FITBIT</span><span class="p">:</span>
<span class="nt">SOURCE</span><span class="p">:</span>
<span class="nt">TYPE</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">DATABASE</span> <span class="c1"># DATABASE or FILES (set each FITBIT_SENSOR TABLE attribute accordingly with a table name or a file path)</span>
<span class="nt">COLUMN_FORMAT</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">JSON</span> <span class="c1"># JSON or PLAIN_TEXT</span>
<span class="nt">DATABASE_GROUP</span><span class="p">:</span> <span class="nv">*database_group</span>
<span class="nt">DEVICE_ID_COLUMN</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">fitbit_id</span> <span class="c1"># column name</span>
<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">SINGLE</span> <span class="c1"># Fitbit only supports SINGLE timezones</span>
<span class="nt">VALUE</span><span class="p">:</span> <span class="nv">*timezone</span>
<p>You might need to modify the following config keys in your <code>config.yaml</code> depending on what devices your participants used and where you are storing your data. You can ignore <code>[PHONE_DATA_CONFIGURATION]</code> or <code>[FITBIT_DATA_CONFIGURATION]</code> if you are not working with either devices.</p>
<div class="tabbed-set" data-tabs="3:2"><input checked="checked" id="__tabbed_3_1" name="__tabbed_3" type="radio" /><label for="__tabbed_3_1">Phone</label><div class="tabbed-content">
<p>The relevant <code>config.yaml</code> section looks like this by default:</p>
<div class="highlight"><pre><span></span><code><span class="nt">PHONE_DATA_CONFIGURATION</span><span class="p">:</span>
<span class="nt">SOURCE</span><span class="p">:</span>
<span class="nt">TYPE</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">DATABASE</span>
<span class="nt">DATABASE_GROUP</span><span class="p">:</span> <span class="nv">*database_group</span>
<span class="nt">DEVICE_ID_COLUMN</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">device_id</span> <span class="c1"># column name</span>
<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">SINGLE</span> <span class="c1"># SINGLE (MULTIPLE support coming soon)</span>
<span class="nt">VALUE</span><span class="p">:</span> <span class="nv">*timezone</span>
</code></pre></div>
<p><strong>For <code>[DEVICE_DATA][PHONE]</code></strong></p>
<p><strong>Parameters for <code>[PHONE_DATA_CONFIGURATION]</code></strong></p>
<table>
<thead>
<tr>
@ -1532,11 +1519,11 @@ mood,1587906020000,7D,0,0,a748ee1a-1d0b-4ae9-9074-279a2b6ba524
</tr>
<tr>
<td><code>[SOURCE] [DEVICE_ID_COLUMN]</code></td>
<td>The column that has strings that uniquely identify smartphones. For data collected with AWARE this is usually <code>device_id</code></td>
<td>A column that contains strings that uniquely identify smartphones. For data collected with AWARE this is usually <code>device_id</code></td>
</tr>
<tr>
<td><code>[TIMEZONE] [TYPE]</code></td>
<td>Only <code>SINGLE</code> is supported</td>
<td>Only <code>SINGLE</code> is supported for now</td>
</tr>
<tr>
<td><code>[TIMEZONE] [VALUE]</code></td>
@ -1544,7 +1531,20 @@ mood,1587906020000,7D,0,0,a748ee1a-1d0b-4ae9-9074-279a2b6ba524
</tr>
</tbody>
</table>
<p><strong>For <code>[DEVICE_DATA][FITBIT]</code></strong></p>
</div>
<input id="__tabbed_3_2" name="__tabbed_3" type="radio" /><label for="__tabbed_3_2">Fitbit</label><div class="tabbed-content">
<p>The relevant <code>config.yaml</code> section looks like this by default:</p>
<div class="highlight"><pre><span></span><code><span class="nt">FITBIT_DATA_CONFIGURATION</span><span class="p">:</span>
<span class="nt">SOURCE</span><span class="p">:</span>
<span class="nt">TYPE</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">DATABASE</span> <span class="c1"># DATABASE or FILES (set each [FITBIT_SENSOR][TABLE] attribute with a table name or a file path accordingly)</span>
<span class="nt">COLUMN_FORMAT</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">JSON</span> <span class="c1"># JSON or PLAIN_TEXT</span>
<span class="nt">DATABASE_GROUP</span><span class="p">:</span> <span class="nv">*database_group</span>
<span class="nt">DEVICE_ID_COLUMN</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">device_id</span> <span class="c1"># column name</span>
<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">SINGLE</span> <span class="c1"># Fitbit devices don&#39;t support time zones so we read this data in the timezone indicated by VALUE </span>
<span class="nt">VALUE</span><span class="p">:</span> <span class="nv">*timezone</span>
</code></pre></div>
<p><strong>Parameters for For <code>[FITBIT_DATA_CONFIGURATION]</code></strong></p>
<table>
<thead>
<tr>
@ -1559,7 +1559,7 @@ mood,1587906020000,7D,0,0,a748ee1a-1d0b-4ae9-9074-279a2b6ba524
</tr>
<tr>
<td><code>[SOURCE]</code> <code>[COLUMN_FORMAT]</code></td>
<td><code>JSON</code> or <code>PLAIN_TEXT</code>. Column format of the source data.</td>
<td><code>JSON</code> or <code>PLAIN_TEXT</code>. Column format of the source data. If you pulled your data directly from the Fitbit API the column containing the sensor data will be in <code>JSON</code> format</td>
</tr>
<tr>
<td><code>[SOURCE]</code> <code>[DATABASE_GROUP]</code></td>
@ -1567,7 +1567,7 @@ mood,1587906020000,7D,0,0,a748ee1a-1d0b-4ae9-9074-279a2b6ba524
</tr>
<tr>
<td><code>[SOURCE]</code> <code>[DEVICE_ID_COLUMN]</code></td>
<td>The column that has strings that uniquely identify Fitbit devices.</td>
<td>A column that contains strings that uniquely identify Fitbit devices.</td>
</tr>
<tr>
<td><code>[TIMEZONE]</code> <code>[TYPE]</code></td>
@ -1579,59 +1579,15 @@ mood,1587906020000,7D,0,0,a748ee1a-1d0b-4ae9-9074-279a2b6ba524
</tr>
</tbody>
</table>
</div>
</div>
<hr />
<h2 id="sensor-and-features-to-process">Sensor and Features to Process<a class="headerlink" href="#sensor-and-features-to-process" title="Permanent link">&para;</a></h2>
<p>Finally, you need to modify the <code>config.yaml</code> of the sensors you want to process. All sensors follow the same naming nomenclature <code>DEVICE_SENSOR</code> and have the following basic attributes (we will use <code>PHONE_MESSAGES</code> as an example). </p>
<div class="admonition hint">
<p class="admonition-title">Hint</p>
<p>Every time you change any sensor parameters, all the necessary files will be updated as soon as you execute RAPIDS. Some sensors will have specific attributes (like <code>MESSAGES_TYPES</code>) so refer to each sensor documentation.</p>
<p>Finally, you need to modify the <code>config.yaml</code> section of the sensors you want to extract behavioral features from. All sensors follow the same naming nomenclature (<code>DEVICE_SENSOR</code>) and parameter structure which we explain in the <a href="../../features/feature-introduction/">Behavioral Features Introduction</a>. </p>
<div class="admonition done">
<p class="admonition-title">Done</p>
<p>Head over to <a href="../execution/">Execution</a> to learn how to execute RAPIDS.</p>
</div>
<div class="highlight"><pre><span></span><code><span class="nt">PHONE_MESSAGES</span><span class="p">:</span>
<span class="nt">TABLE</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">messages</span>
<span class="nt">PROVIDERS</span><span class="p">:</span>
<span class="nt">RAPIDS</span><span class="p">:</span>
<span class="nt">COMPUTE</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">True</span>
<span class="nt">MESSAGES_TYPES </span><span class="p">:</span> <span class="p p-Indicator">[</span><span class="nv">received</span><span class="p p-Indicator">,</span> <span class="nv">sent</span><span class="p p-Indicator">]</span>
<span class="nt">FEATURES</span><span class="p">:</span>
<span class="nt">received</span><span class="p">:</span> <span class="p p-Indicator">[</span><span class="nv">count</span><span class="p p-Indicator">,</span> <span class="nv">distinctcontacts</span><span class="p p-Indicator">,</span> <span class="nv">timefirstmessage</span><span class="p p-Indicator">,</span> <span class="nv">timelastmessage</span><span class="p p-Indicator">,</span> <span class="nv">countmostfrequentcontact</span><span class="p p-Indicator">]</span>
<span class="nt">sent</span><span class="p">:</span> <span class="p p-Indicator">[</span><span class="nv">count</span><span class="p p-Indicator">,</span> <span class="nv">distinctcontacts</span><span class="p p-Indicator">,</span> <span class="nv">timefirstmessage</span><span class="p p-Indicator">,</span> <span class="nv">timelastmessage</span><span class="p p-Indicator">,</span> <span class="nv">countmostfrequentcontact</span><span class="p p-Indicator">]</span>
<span class="nt">SRC_LANGUAGE</span><span class="p">:</span> <span class="s">&quot;r&quot;</span>
<span class="nt">SRC_FOLDER</span><span class="p">:</span> <span class="s">&quot;rapids&quot;</span> <span class="c1"># inside src/features/phone_messages</span>
</code></pre></div>
<table>
<thead>
<tr>
<th>Key&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>[TABLE]</code></td>
<td>The name of the table in your database that stores this sensor data.</td>
</tr>
<tr>
<td><code>[PROVIDERS]</code></td>
<td>A collection of <code>providers</code> . A provider is an author or group of authors that created specific features for the sensor at hand. The provider for all the features implemented by our team is called <code>RAPIDS</code> but we have also included contributions from other researchers (for example <code>DORYAB</code> for location features).</td>
</tr>
<tr>
<td><code>[PROVIDER]</code> <code>[COMPUTE]</code></td>
<td>Set this to <code>TRUE</code> if you want to process features for this <code>provider</code> .</td>
</tr>
<tr>
<td><code>[PROVIDER]</code> <code>[FEATURES]</code></td>
<td>A list of all the features available for the <code>provider</code> . Delete those that you don&rsquo;t want to compute.</td>
</tr>
<tr>
<td><code>[PROVIDER]</code> <code>[SRC_LANGUAGE]</code></td>
<td>The programming language ( <code>r</code> or <code>python</code> ) in which the features of this <code>provider</code> are implemented.</td>
</tr>
<tr>
<td><code>[PROVIDER]</code> <code>[SRC_FOLDER]</code></td>
<td>The folder where the script(s) to compute the features of this <code>provider</code> are stored. This folder is always inside <code>src/features/[DEVICE_SENSOR]/</code></td>
</tr>
</tbody>
</table>

View File

@ -418,18 +418,6 @@
<li class="md-nav__item">
<a href="../../features/phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../../features/phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -514,6 +502,18 @@
<li class="md-nav__item">
<a href="../../features/phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../../features/phone-light/" class="md-nav__link">
Phone Light
@ -884,6 +884,10 @@
<p>After you have <a href="../installation">installed</a> and <a href="../configuration">configured</a> RAPIDS, use the following command to execute it.</p>
<div class="highlight"><pre><span></span><code>./rapids -j1
</code></pre></div>
<div class="admonition done">
<p class="admonition-title">Ready to extract behavioral features</p>
<p>If you are ready to extract features head over to the <a href="../../features/feature-introduction/">Behavioral Features Introduction</a></p>
</div>
<div class="admonition info">
<p class="admonition-title">Info</p>
<p>The script <code class="highlight">./rapids</code> is a wrapper around Snakemake so you can pass any parameters that Snakemake accepts (e.g. <code>-j1</code>). </p>
@ -910,10 +914,6 @@
<div class="highlight"><pre><span></span><code>./rapids -j1 -R clean
</code></pre></div>
</div>
<div class="admonition done">
<p class="admonition-title">Ready to extract behavioral features</p>
<p>If you are ready to extract features head over to the <a href="../../features/feature-introduction/">Behavioral Features Introduction</a></p>
</div>

View File

@ -418,18 +418,6 @@
<li class="md-nav__item">
<a href="../../features/phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../../features/phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -514,6 +502,18 @@
<li class="md-nav__item">
<a href="../../features/phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../../features/phone-light/" class="md-nav__link">
Phone Light

View File

@ -1,143 +1,143 @@
<?xml version="1.0" encoding="UTF-8"?>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url>
</urlset>

Binary file not shown.

View File

@ -407,18 +407,6 @@
<li class="md-nav__item">
<a href="../features/phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../features/phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -503,6 +491,18 @@
<li class="md-nav__item">
<a href="../features/phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../features/phone-light/" class="md-nav__link">
Phone Light

View File

@ -418,18 +418,6 @@
<li class="md-nav__item">
<a href="../../features/phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../../features/phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -514,6 +502,18 @@
<li class="md-nav__item">
<a href="../../features/phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../../features/phone-light/" class="md-nav__link">
Phone Light

View File

@ -402,18 +402,6 @@
<li class="md-nav__item">
<a href="/features/phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="/features/phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -498,6 +486,18 @@
<li class="md-nav__item">
<a href="/features/phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="/features/phone-light/" class="md-nav__link">
Phone Light

View File

@ -407,18 +407,6 @@
<li class="md-nav__item">
<a href="../features/phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../features/phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -503,6 +491,18 @@
<li class="md-nav__item">
<a href="../features/phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../features/phone-light/" class="md-nav__link">
Phone Light

View File

@ -407,18 +407,6 @@
<li class="md-nav__item">
<a href="../../features/phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../../features/phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -503,6 +491,18 @@
<li class="md-nav__item">
<a href="../../features/phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../../features/phone-light/" class="md-nav__link">
Phone Light

View File

@ -407,18 +407,6 @@
<li class="md-nav__item">
<a href="../../features/phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../../features/phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -503,6 +491,18 @@
<li class="md-nav__item">
<a href="../../features/phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../../features/phone-light/" class="md-nav__link">
Phone Light

View File

@ -407,18 +407,6 @@
<li class="md-nav__item">
<a href="../../features/phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../../features/phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -503,6 +491,18 @@
<li class="md-nav__item">
<a href="../../features/phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../../features/phone-light/" class="md-nav__link">
Phone Light

View File

@ -407,18 +407,6 @@
<li class="md-nav__item">
<a href="../../features/phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../../features/phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -503,6 +491,18 @@
<li class="md-nav__item">
<a href="../../features/phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../../features/phone-light/" class="md-nav__link">
Phone Light

View File

@ -407,18 +407,6 @@
<li class="md-nav__item">
<a href="../../features/phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../../features/phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -503,6 +491,18 @@
<li class="md-nav__item">
<a href="../../features/phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../../features/phone-light/" class="md-nav__link">
Phone Light

View File

@ -407,18 +407,6 @@
<li class="md-nav__item">
<a href="../features/phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../features/phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -503,6 +491,18 @@
<li class="md-nav__item">
<a href="../features/phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../features/phone-light/" class="md-nav__link">
Phone Light

View File

@ -409,18 +409,6 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -505,6 +493,18 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-light/" class="md-nav__link">
Phone Light

View File

@ -474,18 +474,6 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -570,6 +558,18 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-light/" class="md-nav__link">
Phone Light
@ -982,11 +982,11 @@
<p>Every phone or Fitbit sensor has a corresponding config section in <code>config.yaml</code>, these sections follow a similar structure and we&rsquo;ll use <code>PHONE_ACCELEROMETER</code> as an example to explain this structure.</p>
<div class="admonition hint">
<p class="admonition-title">Hint</p>
<p>We recommend reading this page if you are using RAPIDS for the first time</p>
</div>
<div class="admonition hint">
<p class="admonition-title">Hint</p>
<p>All sensor features are stored under <code>/data/processed/features</code> on files per sensor, per participant and per study (all participants).</p>
<ul>
<li>We recommend reading this page if you are using RAPIDS for the first time</li>
<li>All computed sensor features are stored under <code>/data/processed/features</code> on files per sensor, per participant and per study (all participants).</li>
<li>Every time you change any sensor parameters, provider parameters or provider features, all the necessary files will be updated as soon as you execute RAPIDS.</li>
</ul>
</div>
<div class="admonition example">
<p class="admonition-title">Config section example for <code>PHONE_ACCELEROMETER</code></p>
@ -1029,10 +1029,6 @@
<h3 id="provider-features">Provider Features<a class="headerlink" href="#provider-features" title="Permanent link">&para;</a></h3>
<p>Each provider offers a set of behavioral features (see <code>#4.2</code> or <code>#5.2</code> in the example). For some providers these features are grouped in an array (like those for <code>RAPIDS</code> provider in <code>#4.2</code>) but for others they are grouped in a collection of arrays depending on the meaning and purpose of those features (like those for <code>PANDAS</code> provider in <code>#5.2</code>). In either case, you can delete the features you are not interested in and they will not be included in the sensor&rsquo;s output feature file. </p>
<p>We explain each behavioral feature in a table under the <code>Features description</code> heading on each provider documentation page.</p>
<div class="admonition hint">
<p class="admonition-title">Hint</p>
<p>Every time you change any sensor parameters, provider parameters or provider features, all the necessary files will be updated as soon as you execute RAPIDS.</p>
</div>
@ -1066,13 +1062,13 @@
</a>
<a href="../phone-data-yield/" class="md-footer-nav__link md-footer-nav__link--next" rel="next">
<a href="../phone-accelerometer/" class="md-footer-nav__link md-footer-nav__link--next" rel="next">
<div class="md-footer-nav__title">
<div class="md-ellipsis">
<span class="md-footer-nav__direction">
Next
</span>
Phone Data Yield
Phone Accelerometer
</div>
</div>
<div class="md-footer-nav__button md-icon">

View File

@ -409,18 +409,6 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -505,6 +493,18 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-light/" class="md-nav__link">
Phone Light

View File

@ -409,18 +409,6 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -505,6 +493,18 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-light/" class="md-nav__link">
Phone Light

View File

@ -409,18 +409,6 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -505,6 +493,18 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-light/" class="md-nav__link">
Phone Light

View File

@ -409,18 +409,6 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -505,6 +493,18 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-light/" class="md-nav__link">
Phone Light

View File

@ -409,18 +409,6 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -505,6 +493,18 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-light/" class="md-nav__link">
Phone Light

View File

@ -410,18 +410,6 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
@ -552,6 +540,18 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-light/" class="md-nav__link">
Phone Light
@ -1137,7 +1137,7 @@
<div class="md-footer-nav">
<nav class="md-footer-nav__inner md-grid" aria-label="Footer">
<a href="../phone-data-yield/" class="md-footer-nav__link md-footer-nav__link--prev" rel="prev">
<a href="../feature-introduction/" class="md-footer-nav__link md-footer-nav__link--prev" rel="prev">
<div class="md-footer-nav__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
</div>
@ -1146,7 +1146,7 @@
<span class="md-footer-nav__direction">
Previous
</span>
Phone Data Yield
Introduction
</div>
</div>
</a>

View File

@ -411,18 +411,6 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -545,6 +533,18 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-light/" class="md-nav__link">
Phone Light

View File

@ -411,18 +411,6 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -545,6 +533,18 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-light/" class="md-nav__link">
Phone Light

View File

@ -411,18 +411,6 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -545,6 +533,18 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-light/" class="md-nav__link">
Phone Light

View File

@ -411,18 +411,6 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -545,6 +533,18 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-light/" class="md-nav__link">
Phone Light

View File

@ -411,18 +411,6 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -545,6 +533,18 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-light/" class="md-nav__link">
Phone Light

View File

@ -411,18 +411,6 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -545,6 +533,18 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-light/" class="md-nav__link">
Phone Light
@ -1186,13 +1186,13 @@
</a>
<a href="../phone-light/" class="md-footer-nav__link md-footer-nav__link--next" rel="next">
<a href="../phone-data-yield/" class="md-footer-nav__link md-footer-nav__link--next" rel="next">
<div class="md-footer-nav__title">
<div class="md-ellipsis">
<span class="md-footer-nav__direction">
Next
</span>
Phone Light
Phone Data Yield
</div>
</div>
<div class="md-footer-nav__button md-icon">

View File

@ -410,56 +410,6 @@
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
Phone Data Yield
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
Phone Data Yield
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="#rapids-provider" class="md-nav__link">
RAPIDS provider
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../phone-accelerometer/" class="md-nav__link">
@ -544,6 +494,56 @@
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
Phone Data Yield
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
Phone Data Yield
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="#rapids-provider" class="md-nav__link">
RAPIDS provider
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../phone-light/" class="md-nav__link">
@ -1064,7 +1064,7 @@
<div class="md-footer-nav">
<nav class="md-footer-nav__inner md-grid" aria-label="Footer">
<a href="../feature-introduction/" class="md-footer-nav__link md-footer-nav__link--prev" rel="prev">
<a href="../phone-conversation/" class="md-footer-nav__link md-footer-nav__link--prev" rel="prev">
<div class="md-footer-nav__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
</div>
@ -1073,19 +1073,19 @@
<span class="md-footer-nav__direction">
Previous
</span>
Introduction
Phone Conversation
</div>
</div>
</a>
<a href="../phone-accelerometer/" class="md-footer-nav__link md-footer-nav__link--next" rel="next">
<a href="../phone-light/" class="md-footer-nav__link md-footer-nav__link--next" rel="next">
<div class="md-footer-nav__title">
<div class="md-ellipsis">
<span class="md-footer-nav__direction">
Next
</span>
Phone Accelerometer
Phone Light
</div>
</div>
<div class="md-footer-nav__button md-icon">

View File

@ -411,18 +411,6 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -506,6 +494,18 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
@ -1041,7 +1041,7 @@
<div class="md-footer-nav">
<nav class="md-footer-nav__inner md-grid" aria-label="Footer">
<a href="../phone-conversation/" class="md-footer-nav__link md-footer-nav__link--prev" rel="prev">
<a href="../phone-data-yield/" class="md-footer-nav__link md-footer-nav__link--prev" rel="prev">
<div class="md-footer-nav__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
</div>
@ -1050,7 +1050,7 @@
<span class="md-footer-nav__direction">
Previous
</span>
Phone Conversation
Phone Data Yield
</div>
</div>
</a>

View File

@ -411,18 +411,6 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -507,6 +495,18 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-light/" class="md-nav__link">
Phone Light

View File

@ -411,18 +411,6 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -507,6 +495,18 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-light/" class="md-nav__link">
Phone Light

View File

@ -411,18 +411,6 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -507,6 +495,18 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-light/" class="md-nav__link">
Phone Light

View File

@ -411,18 +411,6 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -507,6 +495,18 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-light/" class="md-nav__link">
Phone Light

View File

@ -411,18 +411,6 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -507,6 +495,18 @@
<li class="md-nav__item">
<a href="../phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../phone-light/" class="md-nav__link">
Phone Light

View File

@ -418,18 +418,6 @@
<li class="md-nav__item">
<a href="../features/phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../features/phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -514,6 +502,18 @@
<li class="md-nav__item">
<a href="../features/phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../features/phone-light/" class="md-nav__link">
Phone Light

View File

@ -459,18 +459,6 @@
<li class="md-nav__item">
<a href="features/phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="features/phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -555,6 +543,18 @@
<li class="md-nav__item">
<a href="features/phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="features/phone-light/" class="md-nav__link">
Phone Light

File diff suppressed because one or more lines are too long

View File

@ -535,18 +535,6 @@
<li class="md-nav__item">
<a href="../../features/phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../../features/phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -631,6 +619,18 @@
<li class="md-nav__item">
<a href="../../features/phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../../features/phone-light/" class="md-nav__link">
Phone Light
@ -1488,32 +1488,19 @@ mood,1587906020000,7D,0,0,a748ee1a-1d0b-4ae9-9074-279a2b6ba524
<h3 id="segment-examples">Segment Examples<a class="headerlink" href="#segment-examples" title="Permanent link">&para;</a></h3>
<hr />
<h2 id="device-data-source-configuration">Device Data Source Configuration<a class="headerlink" href="#device-data-source-configuration" title="Permanent link">&para;</a></h2>
<p>You might need to modify the following config keys in your <code>config.yaml</code> depending on what devices your participants used and where you are storing your data.</p>
<div class="admonition hint">
<p class="admonition-title">Hint</p>
<p>You can ignore <code>[DEVICE_DATA][PHONE]</code> or <code>[DEVICE_DATA][FITBIT]</code> if you are not working with either devices.</p>
</div>
<p>The relevant <code>config.yaml</code> section looks as follows by default:</p>
<div class="highlight"><pre><span></span><code><span class="nt">DEVICE_DATA</span><span class="p">:</span>
<span class="nt">PHONE</span><span class="p">:</span>
<span class="nt">SOURCE</span><span class="p">:</span>
<span class="nt">TYPE</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">DATABASE</span>
<span class="nt">DATABASE_GROUP</span><span class="p">:</span> <span class="nv">*database_group</span>
<span class="nt">DEVICE_ID_COLUMN</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">device_id</span> <span class="c1"># column name</span>
<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">SINGLE</span>
<span class="nt">VALUE</span><span class="p">:</span> <span class="nv">*timezone</span>
<span class="nt">FITBIT</span><span class="p">:</span>
<span class="nt">SOURCE</span><span class="p">:</span>
<span class="nt">TYPE</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">DATABASE</span> <span class="c1"># DATABASE or FILES (set each FITBIT_SENSOR TABLE attribute accordingly with a table name or a file path)</span>
<span class="nt">COLUMN_FORMAT</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">JSON</span> <span class="c1"># JSON or PLAIN_TEXT</span>
<span class="nt">DATABASE_GROUP</span><span class="p">:</span> <span class="nv">*database_group</span>
<span class="nt">DEVICE_ID_COLUMN</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">fitbit_id</span> <span class="c1"># column name</span>
<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">SINGLE</span> <span class="c1"># Fitbit only supports SINGLE timezones</span>
<span class="nt">VALUE</span><span class="p">:</span> <span class="nv">*timezone</span>
<p>You might need to modify the following config keys in your <code>config.yaml</code> depending on what devices your participants used and where you are storing your data. You can ignore <code>[PHONE_DATA_CONFIGURATION]</code> or <code>[FITBIT_DATA_CONFIGURATION]</code> if you are not working with either devices.</p>
<div class="tabbed-set" data-tabs="3:2"><input checked="checked" id="__tabbed_3_1" name="__tabbed_3" type="radio" /><label for="__tabbed_3_1">Phone</label><div class="tabbed-content">
<p>The relevant <code>config.yaml</code> section looks like this by default:</p>
<div class="highlight"><pre><span></span><code><span class="nt">PHONE_DATA_CONFIGURATION</span><span class="p">:</span>
<span class="nt">SOURCE</span><span class="p">:</span>
<span class="nt">TYPE</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">DATABASE</span>
<span class="nt">DATABASE_GROUP</span><span class="p">:</span> <span class="nv">*database_group</span>
<span class="nt">DEVICE_ID_COLUMN</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">device_id</span> <span class="c1"># column name</span>
<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">SINGLE</span> <span class="c1"># SINGLE (MULTIPLE support coming soon)</span>
<span class="nt">VALUE</span><span class="p">:</span> <span class="nv">*timezone</span>
</code></pre></div>
<p><strong>For <code>[DEVICE_DATA][PHONE]</code></strong></p>
<p><strong>Parameters for <code>[PHONE_DATA_CONFIGURATION]</code></strong></p>
<table>
<thead>
<tr>
@ -1532,11 +1519,11 @@ mood,1587906020000,7D,0,0,a748ee1a-1d0b-4ae9-9074-279a2b6ba524
</tr>
<tr>
<td><code>[SOURCE] [DEVICE_ID_COLUMN]</code></td>
<td>The column that has strings that uniquely identify smartphones. For data collected with AWARE this is usually <code>device_id</code></td>
<td>A column that contains strings that uniquely identify smartphones. For data collected with AWARE this is usually <code>device_id</code></td>
</tr>
<tr>
<td><code>[TIMEZONE] [TYPE]</code></td>
<td>Only <code>SINGLE</code> is supported</td>
<td>Only <code>SINGLE</code> is supported for now</td>
</tr>
<tr>
<td><code>[TIMEZONE] [VALUE]</code></td>
@ -1544,7 +1531,20 @@ mood,1587906020000,7D,0,0,a748ee1a-1d0b-4ae9-9074-279a2b6ba524
</tr>
</tbody>
</table>
<p><strong>For <code>[DEVICE_DATA][FITBIT]</code></strong></p>
</div>
<input id="__tabbed_3_2" name="__tabbed_3" type="radio" /><label for="__tabbed_3_2">Fitbit</label><div class="tabbed-content">
<p>The relevant <code>config.yaml</code> section looks like this by default:</p>
<div class="highlight"><pre><span></span><code><span class="nt">FITBIT_DATA_CONFIGURATION</span><span class="p">:</span>
<span class="nt">SOURCE</span><span class="p">:</span>
<span class="nt">TYPE</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">DATABASE</span> <span class="c1"># DATABASE or FILES (set each [FITBIT_SENSOR][TABLE] attribute with a table name or a file path accordingly)</span>
<span class="nt">COLUMN_FORMAT</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">JSON</span> <span class="c1"># JSON or PLAIN_TEXT</span>
<span class="nt">DATABASE_GROUP</span><span class="p">:</span> <span class="nv">*database_group</span>
<span class="nt">DEVICE_ID_COLUMN</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">device_id</span> <span class="c1"># column name</span>
<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">SINGLE</span> <span class="c1"># Fitbit devices don&#39;t support time zones so we read this data in the timezone indicated by VALUE </span>
<span class="nt">VALUE</span><span class="p">:</span> <span class="nv">*timezone</span>
</code></pre></div>
<p><strong>Parameters for For <code>[FITBIT_DATA_CONFIGURATION]</code></strong></p>
<table>
<thead>
<tr>
@ -1559,7 +1559,7 @@ mood,1587906020000,7D,0,0,a748ee1a-1d0b-4ae9-9074-279a2b6ba524
</tr>
<tr>
<td><code>[SOURCE]</code> <code>[COLUMN_FORMAT]</code></td>
<td><code>JSON</code> or <code>PLAIN_TEXT</code>. Column format of the source data.</td>
<td><code>JSON</code> or <code>PLAIN_TEXT</code>. Column format of the source data. If you pulled your data directly from the Fitbit API the column containing the sensor data will be in <code>JSON</code> format</td>
</tr>
<tr>
<td><code>[SOURCE]</code> <code>[DATABASE_GROUP]</code></td>
@ -1567,7 +1567,7 @@ mood,1587906020000,7D,0,0,a748ee1a-1d0b-4ae9-9074-279a2b6ba524
</tr>
<tr>
<td><code>[SOURCE]</code> <code>[DEVICE_ID_COLUMN]</code></td>
<td>The column that has strings that uniquely identify Fitbit devices.</td>
<td>A column that contains strings that uniquely identify Fitbit devices.</td>
</tr>
<tr>
<td><code>[TIMEZONE]</code> <code>[TYPE]</code></td>
@ -1579,59 +1579,15 @@ mood,1587906020000,7D,0,0,a748ee1a-1d0b-4ae9-9074-279a2b6ba524
</tr>
</tbody>
</table>
</div>
</div>
<hr />
<h2 id="sensor-and-features-to-process">Sensor and Features to Process<a class="headerlink" href="#sensor-and-features-to-process" title="Permanent link">&para;</a></h2>
<p>Finally, you need to modify the <code>config.yaml</code> of the sensors you want to process. All sensors follow the same naming nomenclature <code>DEVICE_SENSOR</code> and have the following basic attributes (we will use <code>PHONE_MESSAGES</code> as an example). </p>
<div class="admonition hint">
<p class="admonition-title">Hint</p>
<p>Every time you change any sensor parameters, all the necessary files will be updated as soon as you execute RAPIDS. Some sensors will have specific attributes (like <code>MESSAGES_TYPES</code>) so refer to each sensor documentation.</p>
<p>Finally, you need to modify the <code>config.yaml</code> section of the sensors you want to extract behavioral features from. All sensors follow the same naming nomenclature (<code>DEVICE_SENSOR</code>) and parameter structure which we explain in the <a href="../../features/feature-introduction/">Behavioral Features Introduction</a>. </p>
<div class="admonition done">
<p class="admonition-title">Done</p>
<p>Head over to <a href="../execution/">Execution</a> to learn how to execute RAPIDS.</p>
</div>
<div class="highlight"><pre><span></span><code><span class="nt">PHONE_MESSAGES</span><span class="p">:</span>
<span class="nt">TABLE</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">messages</span>
<span class="nt">PROVIDERS</span><span class="p">:</span>
<span class="nt">RAPIDS</span><span class="p">:</span>
<span class="nt">COMPUTE</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">True</span>
<span class="nt">MESSAGES_TYPES </span><span class="p">:</span> <span class="p p-Indicator">[</span><span class="nv">received</span><span class="p p-Indicator">,</span> <span class="nv">sent</span><span class="p p-Indicator">]</span>
<span class="nt">FEATURES</span><span class="p">:</span>
<span class="nt">received</span><span class="p">:</span> <span class="p p-Indicator">[</span><span class="nv">count</span><span class="p p-Indicator">,</span> <span class="nv">distinctcontacts</span><span class="p p-Indicator">,</span> <span class="nv">timefirstmessage</span><span class="p p-Indicator">,</span> <span class="nv">timelastmessage</span><span class="p p-Indicator">,</span> <span class="nv">countmostfrequentcontact</span><span class="p p-Indicator">]</span>
<span class="nt">sent</span><span class="p">:</span> <span class="p p-Indicator">[</span><span class="nv">count</span><span class="p p-Indicator">,</span> <span class="nv">distinctcontacts</span><span class="p p-Indicator">,</span> <span class="nv">timefirstmessage</span><span class="p p-Indicator">,</span> <span class="nv">timelastmessage</span><span class="p p-Indicator">,</span> <span class="nv">countmostfrequentcontact</span><span class="p p-Indicator">]</span>
<span class="nt">SRC_LANGUAGE</span><span class="p">:</span> <span class="s">&quot;r&quot;</span>
<span class="nt">SRC_FOLDER</span><span class="p">:</span> <span class="s">&quot;rapids&quot;</span> <span class="c1"># inside src/features/phone_messages</span>
</code></pre></div>
<table>
<thead>
<tr>
<th>Key&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>[TABLE]</code></td>
<td>The name of the table in your database that stores this sensor data.</td>
</tr>
<tr>
<td><code>[PROVIDERS]</code></td>
<td>A collection of <code>providers</code> . A provider is an author or group of authors that created specific features for the sensor at hand. The provider for all the features implemented by our team is called <code>RAPIDS</code> but we have also included contributions from other researchers (for example <code>DORYAB</code> for location features).</td>
</tr>
<tr>
<td><code>[PROVIDER]</code> <code>[COMPUTE]</code></td>
<td>Set this to <code>TRUE</code> if you want to process features for this <code>provider</code> .</td>
</tr>
<tr>
<td><code>[PROVIDER]</code> <code>[FEATURES]</code></td>
<td>A list of all the features available for the <code>provider</code> . Delete those that you don&rsquo;t want to compute.</td>
</tr>
<tr>
<td><code>[PROVIDER]</code> <code>[SRC_LANGUAGE]</code></td>
<td>The programming language ( <code>r</code> or <code>python</code> ) in which the features of this <code>provider</code> are implemented.</td>
</tr>
<tr>
<td><code>[PROVIDER]</code> <code>[SRC_FOLDER]</code></td>
<td>The folder where the script(s) to compute the features of this <code>provider</code> are stored. This folder is always inside <code>src/features/[DEVICE_SENSOR]/</code></td>
</tr>
</tbody>
</table>

View File

@ -418,18 +418,6 @@
<li class="md-nav__item">
<a href="../../features/phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../../features/phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -514,6 +502,18 @@
<li class="md-nav__item">
<a href="../../features/phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../../features/phone-light/" class="md-nav__link">
Phone Light
@ -884,6 +884,10 @@
<p>After you have <a href="../installation">installed</a> and <a href="../configuration">configured</a> RAPIDS, use the following command to execute it.</p>
<div class="highlight"><pre><span></span><code>./rapids -j1
</code></pre></div>
<div class="admonition done">
<p class="admonition-title">Ready to extract behavioral features</p>
<p>If you are ready to extract features head over to the <a href="../../features/feature-introduction/">Behavioral Features Introduction</a></p>
</div>
<div class="admonition info">
<p class="admonition-title">Info</p>
<p>The script <code class="highlight">./rapids</code> is a wrapper around Snakemake so you can pass any parameters that Snakemake accepts (e.g. <code>-j1</code>). </p>
@ -910,10 +914,6 @@
<div class="highlight"><pre><span></span><code>./rapids -j1 -R clean
</code></pre></div>
</div>
<div class="admonition done">
<p class="admonition-title">Ready to extract behavioral features</p>
<p>If you are ready to extract features head over to the <a href="../../features/feature-introduction/">Behavioral Features Introduction</a></p>
</div>

View File

@ -418,18 +418,6 @@
<li class="md-nav__item">
<a href="../../features/phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../../features/phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -514,6 +502,18 @@
<li class="md-nav__item">
<a href="../../features/phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../../features/phone-light/" class="md-nav__link">
Phone Light

View File

@ -1,143 +1,143 @@
<?xml version="1.0" encoding="UTF-8"?>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-11-25</lastmod>
<lastmod>2020-11-26</lastmod>
<changefreq>daily</changefreq>
</url>
</urlset>

Binary file not shown.

View File

@ -407,18 +407,6 @@
<li class="md-nav__item">
<a href="../features/phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../features/phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -503,6 +491,18 @@
<li class="md-nav__item">
<a href="../features/phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../features/phone-light/" class="md-nav__link">
Phone Light

View File

@ -418,18 +418,6 @@
<li class="md-nav__item">
<a href="../../features/phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../../features/phone-accelerometer/" class="md-nav__link">
Phone Accelerometer
@ -514,6 +502,18 @@
<li class="md-nav__item">
<a href="../../features/phone-data-yield/" class="md-nav__link">
Phone Data Yield
</a>
</li>
<li class="md-nav__item">
<a href="../../features/phone-light/" class="md-nav__link">
Phone Light