2097 lines
59 KiB
HTML
2097 lines
59 KiB
HTML
|
|
<!doctype html>
|
|
<html lang="en" class="no-js">
|
|
<head>
|
|
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
|
|
|
|
|
|
|
|
|
<link rel="canonical" href="https://www.rapids.science/setup/overview/">
|
|
|
|
|
|
|
|
|
|
<link rel="icon" href="../../img/logo.png">
|
|
<meta name="generator" content="mkdocs-1.1.2, mkdocs-material-7.0.7+insiders-2.4.0">
|
|
|
|
|
|
|
|
<title>Overview - RAPIDS</title>
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../../assets/stylesheets/main.ec3b3678.min.css">
|
|
|
|
|
|
<link rel="stylesheet" href="../../assets/stylesheets/palette.de2705de.min.css">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
|
|
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback">
|
|
<style>:root{--md-text-font-family:"Roboto";--md-code-font-family:"Roboto Mono"}</style>
|
|
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../../stylesheets/extra.css">
|
|
|
|
|
|
|
|
|
|
|
|
</head>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<body dir="ltr" data-md-color-scheme="default" data-md-color-primary="blue" data-md-color-accent="blue">
|
|
|
|
|
|
<script>function __prefix(e){return new URL("../..",location).pathname+"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}</script>
|
|
|
|
<script>var palette=__get("__palette");if(null!==palette&&"object"==typeof palette.color)for(var key in palette.color)document.body.setAttribute("data-md-color-"+key,palette.color[key])</script>
|
|
|
|
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
|
|
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
|
|
<label class="md-overlay" for="__drawer"></label>
|
|
<div data-md-component="skip">
|
|
|
|
|
|
<a href="#overview" class="md-skip">
|
|
Skip to content
|
|
</a>
|
|
|
|
</div>
|
|
<div data-md-component="announce">
|
|
|
|
</div>
|
|
|
|
<div data-md-component="outdated" hidden>
|
|
<aside class="md-banner md-banner--warning">
|
|
|
|
<div class="md-banner__inner md-grid md-typeset">
|
|
|
|
You're not viewing the latest stable version of RAPIDS.
|
|
<a href="https://www.rapids.science/">
|
|
<strong> Click here to go to latest. </strong>
|
|
</a>
|
|
|
|
</div>
|
|
<script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
|
|
|
|
</aside>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<header class="md-header" data-md-component="header">
|
|
<nav class="md-header__inner md-grid" aria-label="Header">
|
|
<a href="../.." title="RAPIDS" class="md-header__button md-logo" aria-label="RAPIDS" data-md-component="logo">
|
|
|
|
<img src="../../img/logo.png" alt="logo">
|
|
|
|
</a>
|
|
<label class="md-header__button md-icon" for="__drawer">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
|
|
</label>
|
|
<div class="md-header__title" data-md-component="header-title">
|
|
<div class="md-header__ellipsis">
|
|
<div class="md-header__topic">
|
|
<span class="md-ellipsis">
|
|
RAPIDS
|
|
</span>
|
|
</div>
|
|
<div class="md-header__topic" data-md-component="header-topic">
|
|
<span class="md-ellipsis">
|
|
|
|
Overview
|
|
|
|
</span>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<form class="md-header__option" data-md-component="palette">
|
|
|
|
|
|
|
|
<input class="md-option" data-md-color-media="" data-md-color-scheme="default" data-md-color-primary="blue" data-md-color-accent="blue" type="radio" name="__palette" id="__palette_1">
|
|
<label class="md-header__button md-icon" title="Switch to light mode" for="__palette_2" hidden>
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M17 7H7a5 5 0 0 0-5 5 5 5 0 0 0 5 5h10a5 5 0 0 0 5-5 5 5 0 0 0-5-5m0 8a3 3 0 0 1-3-3 3 3 0 0 1 3-3 3 3 0 0 1 3 3 3 3 0 0 1-3 3z"/></svg>
|
|
</label>
|
|
|
|
|
|
|
|
<input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="blue" data-md-color-accent="blue" type="radio" name="__palette" id="__palette_2">
|
|
<label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_1" hidden>
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M7 10a2 2 0 0 1 2 2 2 2 0 0 1-2 2 2 2 0 0 1-2-2 2 2 0 0 1 2-2m10-3a5 5 0 0 1 5 5 5 5 0 0 1-5 5H7a5 5 0 0 1-5-5 5 5 0 0 1 5-5h10M7 9a3 3 0 0 0-3 3 3 3 0 0 0 3 3h10a3 3 0 0 0 3-3 3 3 0 0 0-3-3H7z"/></svg>
|
|
</label>
|
|
|
|
</form>
|
|
|
|
|
|
|
|
<label class="md-header__button md-icon" for="__search">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
|
|
</label>
|
|
|
|
<div class="md-search" data-md-component="search" role="dialog">
|
|
<label class="md-search__overlay" for="__search"></label>
|
|
<div class="md-search__inner" role="search">
|
|
<form class="md-search__form" name="search">
|
|
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
|
|
<label class="md-search__icon md-icon" for="__search">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
|
|
<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>
|
|
</label>
|
|
<nav class="md-search__options" aria-label="Search">
|
|
|
|
<button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
|
|
</button>
|
|
</nav>
|
|
|
|
<div class="md-search__suggest" data-md-component="search-suggest"></div>
|
|
|
|
</form>
|
|
<div class="md-search__output">
|
|
<div class="md-search__scrollwrap" data-md-scrollfix>
|
|
<div class="md-search-result" data-md-component="search-result">
|
|
<div class="md-search-result__meta">
|
|
Initializing search
|
|
</div>
|
|
<ol class="md-search-result__list"></ol>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="md-header__source">
|
|
|
|
<a href="https://github.com/carissalow/rapids/" title="Go to repository" class="md-source" data-md-component="source">
|
|
<div class="md-source__icon md-icon">
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
|
|
</div>
|
|
<div class="md-source__repository">
|
|
carissalow/rapids
|
|
</div>
|
|
</a>
|
|
</div>
|
|
|
|
</nav>
|
|
|
|
</header>
|
|
|
|
<div class="md-container" data-md-component="container">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<main class="md-main" data-md-component="main">
|
|
<div class="md-main__inner md-grid">
|
|
|
|
|
|
|
|
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
|
|
<div class="md-sidebar__scrollwrap">
|
|
<div class="md-sidebar__inner">
|
|
|
|
|
|
|
|
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
|
|
<label class="md-nav__title" for="__drawer">
|
|
<a href="../.." title="RAPIDS" class="md-nav__button md-logo" aria-label="RAPIDS" data-md-component="logo">
|
|
|
|
<img src="../../img/logo.png" alt="logo">
|
|
|
|
</a>
|
|
RAPIDS
|
|
</label>
|
|
|
|
<div class="md-nav__source">
|
|
|
|
<a href="https://github.com/carissalow/rapids/" title="Go to repository" class="md-source" data-md-component="source">
|
|
<div class="md-source__icon md-icon">
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
|
|
</div>
|
|
<div class="md-source__repository">
|
|
carissalow/rapids
|
|
</div>
|
|
</a>
|
|
</div>
|
|
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../.." class="md-nav__link">
|
|
Home
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" type="checkbox" id="__nav_2" checked>
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_2">
|
|
Setup
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" aria-label="Setup" data-md-level="1">
|
|
<label class="md-nav__title" for="__nav_2">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Setup
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<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">
|
|
Overview
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<a href="./" class="md-nav__link md-nav__link--active">
|
|
Overview
|
|
</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-component="toc" data-md-scrollfix>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#frequently-asked-questions" class="md-nav__link">
|
|
Frequently Asked Questions
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Frequently Asked Questions">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#general" class="md-nav__link">
|
|
General
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#data-streams" class="md-nav__link">
|
|
Data Streams
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#extending-rapids" class="md-nav__link">
|
|
Extending RAPIDS
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../workflow-examples/minimal/" class="md-nav__link">
|
|
Minimal Example
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../installation/" class="md-nav__link">
|
|
Installation
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../configuration/" class="md-nav__link">
|
|
Configuration
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../execution/" class="md-nav__link">
|
|
Execution
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../citation/" class="md-nav__link">
|
|
Citation
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_3">
|
|
Data Streams
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" aria-label="Data Streams" data-md-level="1">
|
|
<label class="md-nav__title" for="__nav_3">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Data Streams
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../datastreams/data-streams-introduction/" class="md-nav__link">
|
|
Introduction
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3_2" type="checkbox" id="__nav_3_2" >
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_3_2">
|
|
Phone
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" aria-label="Phone" data-md-level="2">
|
|
<label class="md-nav__title" for="__nav_3_2">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Phone
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../datastreams/aware-mysql/" class="md-nav__link">
|
|
aware_mysql
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../datastreams/aware-csv/" class="md-nav__link">
|
|
aware_csv
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../datastreams/aware-influxdb/" class="md-nav__link">
|
|
aware_influxdb (beta)
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../datastreams/mandatory-phone-format/" class="md-nav__link">
|
|
Mandatory Phone Format
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3_3" type="checkbox" id="__nav_3_3" >
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_3_3">
|
|
Fitbit
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" aria-label="Fitbit" data-md-level="2">
|
|
<label class="md-nav__title" for="__nav_3_3">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Fitbit
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../datastreams/fitbitjson-mysql/" class="md-nav__link">
|
|
fitbitjson_mysql
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../datastreams/fitbitjson-csv/" class="md-nav__link">
|
|
fitbitjson_csv
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../datastreams/fitbitparsed-mysql/" class="md-nav__link">
|
|
fitbitparsed_mysql
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../datastreams/fitbitparsed-csv/" class="md-nav__link">
|
|
fitbitparsed_csv
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../datastreams/mandatory-fitbit-format/" class="md-nav__link">
|
|
Mandatory Fitbit Format
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3_4" type="checkbox" id="__nav_3_4" >
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_3_4">
|
|
Empatica
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" aria-label="Empatica" data-md-level="2">
|
|
<label class="md-nav__title" for="__nav_3_4">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Empatica
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../datastreams/empatica-zip/" class="md-nav__link">
|
|
empatica_zip
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../datastreams/mandatory-empatica-format/" class="md-nav__link">
|
|
Mandatory Empatica Format
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../datastreams/add-new-data-streams/" class="md-nav__link">
|
|
Add New Data Streams
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_4">
|
|
Behavioral Features
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" aria-label="Behavioral Features" data-md-level="1">
|
|
<label class="md-nav__title" for="__nav_4">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Behavioral Features
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../features/feature-introduction/" class="md-nav__link">
|
|
Introduction
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_2" type="checkbox" id="__nav_4_2" >
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_4_2">
|
|
Phone
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" aria-label="Phone" data-md-level="2">
|
|
<label class="md-nav__title" for="__nav_4_2">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Phone
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../features/phone-accelerometer/" class="md-nav__link">
|
|
Phone Accelerometer
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../features/phone-activity-recognition/" class="md-nav__link">
|
|
Phone Activity Recognition
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../features/phone-applications-crashes/" class="md-nav__link">
|
|
Phone Applications Crashes
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../features/phone-applications-foreground/" class="md-nav__link">
|
|
Phone Applications Foreground
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../features/phone-applications-notifications/" class="md-nav__link">
|
|
Phone Applications Notifications
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../features/phone-battery/" class="md-nav__link">
|
|
Phone Battery
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../features/phone-bluetooth/" class="md-nav__link">
|
|
Phone Bluetooth
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../features/phone-calls/" class="md-nav__link">
|
|
Phone Calls
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../features/phone-conversation/" class="md-nav__link">
|
|
Phone Conversation
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<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-keyboard/" class="md-nav__link">
|
|
Phone Keyboard
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../features/phone-light/" class="md-nav__link">
|
|
Phone Light
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../features/phone-locations/" class="md-nav__link">
|
|
Phone Locations
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../features/phone-log/" class="md-nav__link">
|
|
Phone Log
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../features/phone-messages/" class="md-nav__link">
|
|
Phone Messages
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../features/phone-screen/" class="md-nav__link">
|
|
Phone Screen
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../features/phone-wifi-connected/" class="md-nav__link">
|
|
Phone WiFI Connected
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../features/phone-wifi-visible/" class="md-nav__link">
|
|
Phone WiFI Visible
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_3" type="checkbox" id="__nav_4_3" >
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_4_3">
|
|
Fitbit
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" aria-label="Fitbit" data-md-level="2">
|
|
<label class="md-nav__title" for="__nav_4_3">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Fitbit
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../features/fitbit-data-yield/" class="md-nav__link">
|
|
Fitbit Data Yield
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../features/fitbit-heartrate-summary/" class="md-nav__link">
|
|
Fitbit Heart Rate Summary
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../features/fitbit-heartrate-intraday/" class="md-nav__link">
|
|
Fitbit Heart Rate Intraday
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../features/fitbit-sleep-summary/" class="md-nav__link">
|
|
Fitbit Sleep Summary
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../features/fitbit-sleep-intraday/" class="md-nav__link">
|
|
Fitbit Sleep Intraday
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../features/fitbit-steps-summary/" class="md-nav__link">
|
|
Fitbit Steps Summary
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../features/fitbit-steps-intraday/" class="md-nav__link">
|
|
Fitbit Steps Intraday
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_4" type="checkbox" id="__nav_4_4" >
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_4_4">
|
|
Empatica
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" aria-label="Empatica" data-md-level="2">
|
|
<label class="md-nav__title" for="__nav_4_4">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Empatica
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../features/empatica-accelerometer/" class="md-nav__link">
|
|
Empatica Accelerometer
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../features/empatica-heartrate/" class="md-nav__link">
|
|
Empatica Heart Rate
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../features/empatica-temperature/" class="md-nav__link">
|
|
Empatica Temperature
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../features/empatica-electrodermal-activity/" class="md-nav__link">
|
|
Empatica Electrodermal Activity
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../features/empatica-blood-volume-pulse/" class="md-nav__link">
|
|
Empatica Blood Volume Pulse
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../features/empatica-inter-beat-interval/" class="md-nav__link">
|
|
Empatica Inter Beat Interval
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../features/empatica-tags/" class="md-nav__link">
|
|
Empatica Tags
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../features/add-new-features/" class="md-nav__link">
|
|
Add New Features
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_5">
|
|
Visualizations
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" aria-label="Visualizations" data-md-level="1">
|
|
<label class="md-nav__title" for="__nav_5">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Visualizations
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../visualizations/data-quality-visualizations/" class="md-nav__link">
|
|
Data Quality
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../visualizations/feature-visualizations/" class="md-nav__link">
|
|
Features
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_6">
|
|
Analysis Workflows
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" aria-label="Analysis Workflows" data-md-level="1">
|
|
<label class="md-nav__title" for="__nav_6">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Analysis Workflows
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../workflow-examples/analysis/" class="md-nav__link">
|
|
Complete Example
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_7">
|
|
Developers
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" aria-label="Developers" data-md-level="1">
|
|
<label class="md-nav__title" for="__nav_7">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Developers
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../developers/git-flow/" class="md-nav__link">
|
|
Git Flow
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../developers/remote-support/" class="md-nav__link">
|
|
Remote Support
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../developers/virtual-environments/" class="md-nav__link">
|
|
Virtual Environments
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../developers/documentation/" class="md-nav__link">
|
|
Documentation
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../developers/testing/" class="md-nav__link">
|
|
Testing
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../developers/test-cases/" class="md-nav__link">
|
|
Test cases
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../developers/validation-schema-config/" class="md-nav__link">
|
|
Validation schema of config.yaml
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_8" type="checkbox" id="__nav_8" >
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_8">
|
|
Others
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" aria-label="Others" data-md-level="1">
|
|
<label class="md-nav__title" for="__nav_8">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Others
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../migrating-from-old-versions/" class="md-nav__link">
|
|
Migrating from an old version
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../code_of_conduct/" class="md-nav__link">
|
|
Code of Conduct
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../common-errors/" class="md-nav__link">
|
|
Common Errors
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../team/" class="md-nav__link">
|
|
Team
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../change-log/" class="md-nav__link">
|
|
Change Log
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
|
|
<div class="md-sidebar__scrollwrap">
|
|
<div class="md-sidebar__inner">
|
|
|
|
<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-component="toc" data-md-scrollfix>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#frequently-asked-questions" class="md-nav__link">
|
|
Frequently Asked Questions
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Frequently Asked Questions">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#general" class="md-nav__link">
|
|
General
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#data-streams" class="md-nav__link">
|
|
Data Streams
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#extending-rapids" class="md-nav__link">
|
|
Extending RAPIDS
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="md-content" data-md-component="content">
|
|
<article class="md-content__inner md-typeset">
|
|
|
|
|
|
<a href="https://github.com/carissalow/rapids/edit/master/docs/setup/overview.md" title="Edit this page" class="md-content__button md-icon">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z"/></svg>
|
|
</a>
|
|
|
|
|
|
<h1 id="overview">Overview<a class="headerlink" href="#overview" title="Permanent link">¶</a></h1>
|
|
<p>Let’s review some key concepts we use throughout these docs:</p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Definition </th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>Data Stream</td>
|
|
<td>Set of sensor data collected using a specific type of <strong>device</strong> with a specific <strong>format</strong> and stored in a specific <strong>container</strong>. For example, smartphone (device) data collected with the <a href="https://awareframework.com/">AWARE Framework</a> (format) and stored in a MySQL database (container).</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Device</td>
|
|
<td>A mobile or wearable device, like smartphones, Fitbit wrist bands, Oura Rings, etc.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Sensor</td>
|
|
<td>A physical or digital module builtin in a device that produces a data stream. For example, a smartphone’s accelerometer or screen.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Format</td>
|
|
<td>A file in RAPIDS that describes how sensor data from a device matches RAPIDS data representation.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Container</td>
|
|
<td>An electronic repository of data, it can be a database, a file, a Web API, etc. RAPIDS connects to containers through container scripts.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Participant</td>
|
|
<td>A person that took part in a monitoring study</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Behavioral feature</td>
|
|
<td>A metric computed from raw sensor data quantifying the behavior of a participant. For example, time spent at home computed from location data. These are also known as digital biomarkers</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Time segment</td>
|
|
<td>Time segments (or epochs) are the time windows on which RAPIDS extracts behavioral features. For example, you might want to compute participants’ time at home every morning or only during weekends. You define time segments in a CSV file that RAPIDS processes.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Time zone</td>
|
|
<td>A string code like <code>America/New_York</code> that represents a time zone where a device logged data. You can process data collected in single or multiple time zones.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Provider</td>
|
|
<td>A script that creates behavioral features for a specific sensor. Providers are created by the core RAPIDS team or by the community, which are named after its first author like <a href="../../features/phone-locations/#doryab-provider">[PHONE_LOCATIONS][DORYAB]</a>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>config.yaml</td>
|
|
<td>A YAML file where you can modify parameters to process data streams and behavioral features. This is the heart of RAPIDS and the file that you will modify the most.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>credentials.yaml</td>
|
|
<td>A YAML file where you can define credential groups (user, password, host, etc.) if your data stream needs to connect to a database or Web API</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Participant file(s)</td>
|
|
<td>A YAML file that links one or more smartphone or wearable devices that a single participant used. RAPIDS needs one file per participant.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<div class="admonition success">
|
|
<p class="admonition-title">What can I do with RAPIDS?</p>
|
|
<p>You can do one or more of these things with RAPIDS:</p>
|
|
<ol>
|
|
<li><a href="../../features/feature-introduction/">Extract behavioral features</a> from smartphone, Fitbit, and Empatica’s <a href="../../datastreams/data-streams-introduction/">supported data streams</a></li>
|
|
<li><a href="../../features/add-new-features/">Add your own behavioral features</a> (we can include them in RAPIDS if you want to share them with the community)</li>
|
|
<li><a href="../../datastreams/add-new-data-streams/">Add support for new data streams</a> if yours cannot be processed by RAPIDS yet</li>
|
|
<li>Create visualizations for <a href="../../visualizations/data-quality-visualizations/">data quality control</a> and <a href="../../visualizations/feature-visualizations/">feature inspection</a></li>
|
|
<li><a href="../../workflow-examples/analysis/">Extending RAPIDS to organize your analysis</a> and publish a code repository along with your code</li>
|
|
</ol>
|
|
</div>
|
|
<div class="admonition hint">
|
|
<p class="admonition-title">Hint</p>
|
|
<ul>
|
|
<li>
|
|
<p><strong>In order to follow any of the previous tutorials, you will have to <a href="../installation/">Install</a>, <a href="../configuration/">Configure</a>, and learn how to <a href="../execution/">Execute</a> RAPIDS.</strong></p>
|
|
</li>
|
|
<li>
|
|
<p>We recommend you follow the <a href="../../workflow-examples/minimal/">Minimal Example</a> tutorial to get familiar with RAPIDS</p>
|
|
</li>
|
|
<li>
|
|
<p><a href="../../team">Email us</a>, leave a comment in these docs, create a <a href="https://github.com/carissalow/rapids/issues">Github issue</a> or text us in <a href="http://awareframework.com:3000/">Slack</a> if you have any questions</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<h2 id="frequently-asked-questions">Frequently Asked Questions<a class="headerlink" href="#frequently-asked-questions" title="Permanent link">¶</a></h2>
|
|
<h3 id="general">General<a class="headerlink" href="#general" title="Permanent link">¶</a></h3>
|
|
<details class="question"><summary>What exactly is RAPIDS?</summary><p>RAPIDS is a group of configuration files and R and Python scripts that are executed by <a href="https://snakemake.github.io/">Snakemake</a>. You can get a copy of RAPIDS by cloning our Github repository.</p>
|
|
<p>RAPIDS is not a web application or server; all the processing is done in your laptop, server, or computer cluster.</p>
|
|
</details>
|
|
<details class="question"><summary>How does RAPIDS work?</summary><p>You will most of the time only have to modify configuration files in YAML format (<code>config.yaml</code>, <code>credentials.yaml</code>, and participant files <code>pxx.yaml</code>), and in CSV format (time zones and time segments).</p>
|
|
<p>RAPIDS pulls data from different data containers and processes it in steps. The input/output of each step is saved as a CSV file for inspection; you can check the files that are created for each sensor on its documentation page. </p>
|
|
<p>All data is stored in <code>data/</code>, and all processing Python and R scripts are stored in <code>src/</code>.</p>
|
|
<details class="example"><summary>User and File interactions in RAPIDS</summary><p>In the figure below, we represent the interactions between users and files. After a user modifies the configuration files mentioned above, the <code>Snakefile</code> file will search for and execute the Snakemake rules that contain the Python or R scripts necessary to generate or update the required output files (behavioral features, plots, etc.).</p>
|
|
<p><figure>
|
|
<img src="../../img/files.png" max-width="50%" />
|
|
<figcaption>Interaction diagram between the user, and important files in RAPIDS</figcaption>
|
|
</figure></p>
|
|
</details>
|
|
<details class="example"><summary>Data flow in RAPIDS</summary><p>In the figure below, we represent the flow of data in RAPIDS. In broad terms, smartphone and wearable devices log <a href="../../datastreams/data-streams-introduction/">data streams</a> with a certain format to a data container (database, file, etc.). </p>
|
|
<p>RAPIDS can connect to these containers if it has a <code>format.yaml</code> and a <code>container.[R|py]</code> script used to pull the correct data and mutate it to comply with RAPIDS’ internal data representation. Once the data stream is in RAPIDS, it goes through some basic transformations (scripts), one that assigns a time segment and a time zone to each data row, and another one that creates “episodes” of data for some sensors that need it (like screen, battery, activity recognition, and sleep intraday data).</p>
|
|
<p>After this, RAPIDS executes the requested <code>PROVIDER</code> script that computes behavioral features per time segment instance. After every feature is computed, they are joined per sensor, per participant, and study. Visualizations are built based on raw data or based on computed features. </p>
|
|
<p><figure>
|
|
<img src="../../img/dataflow.png" max-width="50%" />
|
|
<figcaption>Data stream flow in RAPIDS</figcaption>
|
|
</figure></p>
|
|
</details>
|
|
</details>
|
|
<details class="question"><summary>Is my data private?</summary><p>Absolutely, you are processing your data with your own copy of RAPIDS in your laptop, server, or computer cluster, so neither we nor anyone else can have access to your datasets.</p>
|
|
</details>
|
|
<details class="question"><summary>Do I need to have coding skills to use RAPIDS?</summary><p>If you want to extract the behavioral features or visualizations that RAPIDS offers out of the box, the answer is no. However, you need to be comfortable running commands in your terminal and familiar with editing YAML files and CSV files.</p>
|
|
<p>If you want to add support for new data streams or behavioral features, you need to be familiar with R or Python.</p>
|
|
</details>
|
|
<details class="question"><summary>Is RAPIDS open-source or free?</summary><p>Yes, RAPIDS is both open-source and free.</p>
|
|
</details>
|
|
<details class="question"><summary>How do I cite RAPIDS?</summary><p>Please refer to our <a href="../../citation/">Citation guide</a>; depending on what parts of RAPIDS you used, we also ask you to cite the work of other authors that shared their work.</p>
|
|
</details>
|
|
<details class="question"><summary>I have a lot of data, can RAPIDS handle it/ is RAPIDS fast enough?</summary><p>Yes, we use Snakemake under the hood, so you can automatically distribute RAPIDS execution over multiple <a href="../execution/">cores</a> or <a href="https://snakemake.readthedocs.io/en/stable/executing/cluster.html">clusters</a>. RAPIDS processes data per sensor and participant, so it can take advantage of this parallel processing.</p>
|
|
</details>
|
|
<details class="question"><summary>What are the advantages of using RAPIDS over implementing my own analysis code?</summary><p>We believe RAPIDS can benefit your analysis in several ways:</p>
|
|
<ul>
|
|
<li>RAPIDS has more than 250 <a href="../../features/add-new-features/">behavioral features</a> available, many of them tested and used by other researchers.</li>
|
|
<li>RAPIDS can extract features in dynamic <a href="../../setup/configuration/#time-segments">time segments</a> (for example, every x minutes, x hours, x days, x weeks, x months, etc.). This is handy because you don’t have to deal with time zones, day light saving changes, or date arithmetic.</li>
|
|
<li>Your analysis is less prone to errors. Every participant sensor dataset is analyzed in the same way and isolated from each other.</li>
|
|
<li>If you have lots of data, out-of-the-box parallel execution will speed up your analysis and if your computer crashes, RAPIDS will start from where it left of. </li>
|
|
<li>You can publish your analysis code along with your papers and be sure it will run exactly as it does in your computer.</li>
|
|
<li>You can still add your own <a href="../../features/add-new-features/">behavioral features</a> and <a href="../../datastreams/add-new-data-streams/">data streams</a> if you need to, and the community will be able to reuse your work.</li>
|
|
</ul>
|
|
</details>
|
|
<h3 id="data-streams">Data Streams<a class="headerlink" href="#data-streams" title="Permanent link">¶</a></h3>
|
|
<details class="question"><summary>Can I process smartphone data collected with Beiwe, PurpleRobot, or app X?</summary><p>Yes, but you need to add a new data stream to RAPIDS (a new <code>format.yaml</code> and container script in R or Python). Follow this <a href="../../datastreams/add-new-data-streams/">tutorial</a>. <a href="../../team">Email us</a>, create a <a href="https://github.com/carissalow/rapids/issues">Github issue</a> or text us in <a href="http://awareframework.com:3000/">Slack</a> if you have any questions.</p>
|
|
<p>If you do so, let us know so we can integrate your work into RAPIDS.</p>
|
|
</details>
|
|
<details class="question"><summary>Can I process data from Oura Rings, Actigraphs, or wearable X?</summary><p>The only wearables we support at the moment are Empatica and Fitbit. However, get in touch if you need to process data from a different wearable. We have limited resources so we add support for different devices on an as-needed basis, but we would be happy to collaborate with you to add new wearables. <a href="../../team">Email us</a>, create a <a href="https://github.com/carissalow/rapids/issues">Github issue</a> or text us in <a href="http://awareframework.com:3000/">Slack</a> if you have any questions.</p>
|
|
</details>
|
|
<details class="question"><summary>Can I process smartphone or wearable data stored in PostgreSQL, Oracle, SQLite, CSV files, or data container X?</summary><p>Yes, but you need to add a new data stream to RAPIDS (a new <code>format.yaml</code> and container script in R or Python). Follow this <a href="../../datastreams/add-new-data-streams/">tutorial</a>. If you are processing data streams we already support like AWARE, Fitbit, or Empatica and are just connecting to a different container; you can reuse their <code>format.yaml</code> and only implement a new container script. <a href="../../team">Email us</a>, create a <a href="https://github.com/carissalow/rapids/issues">Github issue</a> or text us in <a href="http://awareframework.com:3000/">Slack</a> if you have any questions.</p>
|
|
<p>If you do so, let us know so we can integrate your work into RAPIDS.</p>
|
|
</details>
|
|
<details class="question"><summary>I have participants that live in different time zones and some that travel; can RAPIDS handle this?</summary><p>Yes, RAPIDS can handle <a href="../../setup/configuration/#timezone-of-your-study">single or multiple timezones</a> per participant. You can use time zone data collected by smartphones or collected by hand.</p>
|
|
</details>
|
|
<details class="question"><summary>Some of my participants used more than one device during my study; can RAPIDS handle this?</summary><p>Yes, you can link more than one smartphone or wearable device to a single participant. RAPIDS will merge them and sort them automatically.</p>
|
|
</details>
|
|
<details class="question"><summary>Some of my participants switched from Android to iOS or vice-versa during my study; can RAPIDS handle this?</summary><p>Yes, data from multiple smartphones can be linked to a single participant. All iOS data is converted to Android data before merging it.</p>
|
|
</details>
|
|
<h3 id="extending-rapids">Extending RAPIDS<a class="headerlink" href="#extending-rapids" title="Permanent link">¶</a></h3>
|
|
<details class="question"><summary>Can I add my own behavioral features/digital biomarkers?</summary><p>Yes, you can implement your own features in R or Python following this <a href="../../features/add-new-features/">tutorial</a> </p>
|
|
</details>
|
|
<details class="question"><summary>Can I extract behavioral features based on two or more sensors?</summary><p>Yes, we do this for <code>PHONE_DATA_YIELD</code> (combines all phone sensors), <code>PHONE_LOCATIONS</code> (combines location and data yield data), <code>PHONE_APPLICATIONS_BACKGROUND</code> (combines screen and app usage data), and <code>FITBIT_INTRADAY_STEPS</code> (combines Fitbit and sleep and step data). </p>
|
|
<p>However, we haven’t come up with a user-friendly way to configure this, and currently, we join sensors on a case-by-case basis. This is mainly because not enough users have needed this functionality so far. Get in touch, and we can set it up together; the more use cases we are aware of, the easier it will be to integrate this into RAPIDS.</p>
|
|
</details>
|
|
<details class="question"><summary>I know how to program in Python or R but not both. Can I still use or extend RAPIDS?</summary><p>Yes, you don’t need to write any code to use RAPIDS out of the box. If you need to add support for new <a href="../../datastreams/add-new-data-streams/">data streams</a> or <a href="../../features/add-new-features/">behavioral features</a> you can use scripts in either language.</p>
|
|
</details>
|
|
<details class="question"><summary>I have scripts that clean raw data from X sensor, can I use them with RAPIDS?</summary><p>Yes, you can add them as a <a href="../../datastreams/add-new-data-streams/#complex-mapping"><code>[MUTATION][SCRIPT]</code></a> in the <code>format.yaml</code> of the <a href="../../datastreams/data-streams-introduction/">data stream</a> you are using. You will add a <code>main</code> function that will receive a data frame with the raw data for that sensor that in turn will be used to compute behavioral features.</p>
|
|
</details>
|
|
|
|
|
|
|
|
<!-- Add custom comment system integration here -->
|
|
<!-- Utterances integration -->
|
|
|
|
<h2 id="__comments">Comments</h2>
|
|
|
|
<script type="text/javascript">
|
|
var rapids_utterances_theme = false
|
|
document.onreadystatechange = function () {
|
|
if (document.readyState == "interactive") {
|
|
// wait for utterances to load and send it's first message.
|
|
addEventListener('message', event => {
|
|
if (event.origin !== 'https://utteranc.es' || rapids_utterances_theme == true) {
|
|
return;
|
|
}
|
|
rapids_utterances_theme = true
|
|
if(document.body.getAttribute("data-md-color-scheme") == "default")
|
|
document.querySelector("iframe.utterances-frame").contentWindow.postMessage({ type: "set-theme", theme: "github-light" },"https://utteranc.es/")
|
|
else
|
|
document.querySelector("iframe.utterances-frame").contentWindow.postMessage({ type: "set-theme", theme: "photon-dark" },"https://utteranc.es/")
|
|
});
|
|
document.getElementById('__palette_1').onclick = function(){
|
|
document.querySelector("iframe.utterances-frame").contentWindow.postMessage({ type: "set-theme", theme: "github-light" },"https://utteranc.es/")
|
|
}
|
|
document.getElementById('__palette_2').onclick = function(){
|
|
document.querySelector("iframe.utterances-frame").contentWindow.postMessage({ type: "set-theme", theme: "photon-dark" },"https://utteranc.es/")
|
|
}
|
|
}
|
|
}
|
|
</script>
|
|
|
|
<script src="https://utteranc.es/client.js"
|
|
repo="carissalow/rapids"
|
|
issue-term="pathname"
|
|
label="docs comments"
|
|
theme="github-light"
|
|
crossorigin="anonymous"
|
|
async>
|
|
</script>
|
|
|
|
|
|
</article>
|
|
</div>
|
|
</div>
|
|
|
|
</main>
|
|
|
|
|
|
<footer class="md-footer">
|
|
|
|
<nav class="md-footer__inner md-grid" aria-label="Footer">
|
|
|
|
<a href="../.." class="md-footer__link md-footer__link--prev" rel="prev">
|
|
<div class="md-footer__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>
|
|
<div class="md-footer__title">
|
|
<div class="md-ellipsis">
|
|
<span class="md-footer__direction">
|
|
Previous
|
|
</span>
|
|
Home
|
|
</div>
|
|
</div>
|
|
</a>
|
|
|
|
|
|
<a href="../../workflow-examples/minimal/" class="md-footer__link md-footer__link--next" rel="next">
|
|
<div class="md-footer__title">
|
|
<div class="md-ellipsis">
|
|
<span class="md-footer__direction">
|
|
Next
|
|
</span>
|
|
Minimal Example
|
|
</div>
|
|
</div>
|
|
<div class="md-footer__button md-icon">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg>
|
|
</div>
|
|
</a>
|
|
|
|
</nav>
|
|
|
|
<div class="md-footer-meta md-typeset">
|
|
<div class="md-footer-meta__inner md-grid">
|
|
<div class="md-footer-copyright">
|
|
|
|
<div class="md-footer-copyright__highlight">
|
|
Released under AGPL
|
|
</div>
|
|
|
|
|
|
Made with
|
|
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
|
|
Material for MkDocs Insiders
|
|
</a>
|
|
|
|
|
|
</div>
|
|
|
|
<div class="md-footer-social">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a href="https://twitter.com/julio_ui" target="_blank" rel="noopener" title="twitter.com" class="md-footer-social__link">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><path d="M459.37 151.716c.325 4.548.325 9.097.325 13.645 0 138.72-105.583 298.558-298.558 298.558-59.452 0-114.68-17.219-161.137-47.106 8.447.974 16.568 1.299 25.34 1.299 49.055 0 94.213-16.568 130.274-44.832-46.132-.975-84.792-31.188-98.112-72.772 6.498.974 12.995 1.624 19.818 1.624 9.421 0 18.843-1.3 27.614-3.573-48.081-9.747-84.143-51.98-84.143-102.985v-1.299c13.969 7.797 30.214 12.67 47.431 13.319-28.264-18.843-46.781-51.005-46.781-87.391 0-19.492 5.197-37.36 14.294-52.954 51.655 63.675 129.3 105.258 216.365 109.807-1.624-7.797-2.599-15.918-2.599-24.04 0-57.828 46.782-104.934 104.934-104.934 30.213 0 57.502 12.67 76.67 33.137 23.715-4.548 46.456-13.32 66.599-25.34-7.798 24.366-24.366 44.833-46.132 57.827 21.117-2.273 41.584-8.122 60.426-16.243-14.292 20.791-32.161 39.308-52.628 54.253z"/></svg>
|
|
</a>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
|
|
</div>
|
|
<div class="md-dialog" data-md-component="dialog">
|
|
<div class="md-dialog__inner md-typeset"></div>
|
|
</div>
|
|
<script id="__config" type="application/json">{"base": "../..", "features": ["navigation.sections", "search.suggest", "search.highlight"], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing"}, "search": "../../assets/javascripts/workers/search.d10a1f1d.min.js", "version": {"provider": "mike"}}</script>
|
|
|
|
|
|
<script src="../../assets/javascripts/bundle.9aafa2c6.min.js"></script>
|
|
|
|
<script src="https://polyfill.io/v3/polyfill.min.js?features=es6"></script>
|
|
|
|
<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
|
|
|
|
|
|
</body>
|
|
</html> |