2020-11-09 18:42:20 +01:00
<!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 = "shortcut icon" href = "assets/images/favicon.png" >
< meta name = "generator" content = "mkdocs-1.1.2, mkdocs-material-6.1.4+insiders-1.9.0" >
< title > RAPIDS< / title >
< link rel = "stylesheet" href = "assets/stylesheets/main.a2a6bca7.min.css" >
< link rel = "stylesheet" href = "assets/stylesheets/palette.c308bc62.min.css" >
< link href = "https://fonts.gstatic.com" rel = "preconnect" crossorigin >
< link rel = "stylesheet" href = "https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback" >
< style > body , input { font-family : "Roboto" , - apple-system , BlinkMacSystemFont , Helvetica , Arial , sans-serif } code , kbd , pre { font-family : "Roboto Mono" , SFMono-Regular , Consolas , Menlo , monospace } < / 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 > var palette = JSON . parse ( localStorage . getItem ( "__palette" ) || "{}" ) ; if ( void 0 !== 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 = "#welcome-to-rapids-documentation" class = "md-skip" >
Skip to content
< / a >
< / div >
< div data-md-component = "announce" >
< / div >
< header class = "md-header" data-md-component = "header" >
< nav class = "md-header-nav md-grid" aria-label = "Header" >
< a href = "." title = "RAPIDS" class = "md-header-nav__button md-logo" aria-label = "RAPIDS" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M19 18.31V20a2 2 0 01-2 2H7a2 2 0 01-2-2v-3.7c-.46-.18-1.05-.3-2-.3a1 1 0 01-1-1 1 1 0 011-1c.82 0 1.47.08 2 .21V12.3c-.46-.18-1.05-.3-2-.3a1 1 0 01-1-1 1 1 0 011-1c.82 0 1.47.08 2 .21V8.3C4.54 8.12 3.95 8 3 8a1 1 0 01-1-1 1 1 0 011-1c.82 0 1.47.08 2 .21V4a2 2 0 012-2h10a2 2 0 012 2v2.16c1.78.31 2.54.97 2.71 1.13.39.39.39 1.03 0 1.42-.39.39-.91.38-1.42 0 0 0-1.04-.71-3.29-.71-1.26 0-2.09.41-3.05.9-1.04.51-2.21 1.1-3.95 1.1-.36 0-.69 0-1-.04V7.95c.3.05.63.05 1 .05 1.26 0 2.09-.41 3.05-.89C14.09 6.59 15.27 6 17 6V4H7v16h10v-2c1.5 0 1.97.29 2 .31M17 10c-1.73 0-2.91.59-3.95 1.11-.96.48-1.79.89-3.05.89-.37 0-.7 0-1-.05v2.01c.31.04.64.04 1 .04 1.74 0 2.91-.59 3.95-1.1.96-.48 1.79-.9 3.05-.9 2.25 0 3.29.71 3.29.71.51.39 1.03.39 1.42 0 .39-.39.39-1.02 0-1.42C21.5 11.08 20.25 10 17 10m0 4c-1.73 0-2.91.59-3.95 1.11-.96.48-1.79.89-3.05.89-.37 0-.7 0-1-.05v2.01c.31.04.64.04 1 .04 1.74 0 2.91-.59 3.95-1.1.96-.48 1.79-.9 3.05-.9 2.25 0 3.29.71 3.29.71.51.39 1.03.39 1.42 0 .39-.39.39-1.02 0-1.42C21.5 15.08 20.25 14 17 14z" / > < / svg >
< / a >
< label class = "md-header-nav__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-nav__title" data-md-component = "header-title" >
< div class = "md-header-nav__ellipsis" >
< div class = "md-header-nav__topic" >
< span class = "md-ellipsis" >
RAPIDS
< / span >
< / div >
< div class = "md-header-nav__topic" data-md-component = "header-topic" >
< span class = "md-ellipsis" >
Home
< / span >
< / div >
< / div >
< / div >
< div class = "md-header-nav__options" >
< button class = "md-header-nav__button md-icon" title = "Switch to light mode" aria-label = "Switch to light mode" data-md-option = "palette" data-md-color-scheme = "default" data-md-color-primary = "blue" data-md-color-accent = "blue" data-md-state = "hidden" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M17 7H7a5 5 0 00-5 5 5 5 0 005 5h10a5 5 0 005-5 5 5 0 00-5-5m0 8a3 3 0 01-3-3 3 3 0 013-3 3 3 0 013 3 3 3 0 01-3 3z" / > < / svg >
< / button >
< button class = "md-header-nav__button md-icon" title = "Switch to dark mode" aria-label = "Switch to dark mode" data-md-option = "palette" data-md-color-scheme = "slate" data-md-color-primary = "blue" data-md-color-accent = "blue" data-md-state = "hidden" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M7 10a2 2 0 012 2 2 2 0 01-2 2 2 2 0 01-2-2 2 2 0 012-2m10-3a5 5 0 015 5 5 5 0 01-5 5H7a5 5 0 01-5-5 5 5 0 015-5h10M7 9a3 3 0 00-3 3 3 3 0 003 3h10a3 3 0 003-3 3 3 0 00-3-3H7z" / > < / svg >
< / button >
< / div >
< label class = "md-header-nav__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 0116 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 019.5 16 6.5 6.5 0 013 9.5 6.5 6.5 0 019.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" data-md-state = "active" >
< 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 0116 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 019.5 16 6.5 6.5 0 013 9.5 6.5 6.5 0 019.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 >
< button type = "reset" class = "md-search__icon md-icon" aria-label = "Clear" data-md-component = "search-reset" tabindex = "-1" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M19 6.41L17.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 >
< 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-nav__source" >
< a href = "https://github.com/carissalow/rapids/" title = "Go to repository" class = "md-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.05L244 40.45a28.87 28.87 0 00-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 01-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 000 40.81l195.61 195.6a28.86 28.86 0 0040.8 0l194.69-194.69a28.86 28.86 0 000-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 = "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" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M19 18.31V20a2 2 0 01-2 2H7a2 2 0 01-2-2v-3.7c-.46-.18-1.05-.3-2-.3a1 1 0 01-1-1 1 1 0 011-1c.82 0 1.47.08 2 .21V12.3c-.46-.18-1.05-.3-2-.3a1 1 0 01-1-1 1 1 0 011-1c.82 0 1.47.08 2 .21V8.3C4.54 8.12 3.95 8 3 8a1 1 0 01-1-1 1 1 0 011-1c.82 0 1.47.08 2 .21V4a2 2 0 012-2h10a2 2 0 012 2v2.16c1.78.31 2.54.97 2.71 1.13.39.39.39 1.03 0 1.42-.39.39-.91.38-1.42 0 0 0-1.04-.71-3.29-.71-1.26 0-2.09.41-3.05.9-1.04.51-2.21 1.1-3.95 1.1-.36 0-.69 0-1-.04V7.95c.3.05.63.05 1 .05 1.26 0 2.09-.41 3.05-.89C14.09 6.59 15.27 6 17 6V4H7v16h10v-2c1.5 0 1.97.29 2 .31M17 10c-1.73 0-2.91.59-3.95 1.11-.96.48-1.79.89-3.05.89-.37 0-.7 0-1-.05v2.01c.31.04.64.04 1 .04 1.74 0 2.91-.59 3.95-1.1.96-.48 1.79-.9 3.05-.9 2.25 0 3.29.71 3.29.71.51.39 1.03.39 1.42 0 .39-.39.39-1.02 0-1.42C21.5 11.08 20.25 10 17 10m0 4c-1.73 0-2.91.59-3.95 1.11-.96.48-1.79.89-3.05.89-.37 0-.7 0-1-.05v2.01c.31.04.64.04 1 .04 1.74 0 2.91-.59 3.95-1.1.96-.48 1.79-.9 3.05-.9 2.25 0 3.29.71 3.29.71.51.39 1.03.39 1.42 0 .39-.39.39-1.02 0-1.42C21.5 15.08 20.25 14 17 14z" / > < / svg >
< / a >
RAPIDS
< / label >
< div class = "md-nav__source" >
< a href = "https://github.com/carissalow/rapids/" title = "Go to repository" class = "md-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.05L244 40.45a28.87 28.87 0 00-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 01-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 000 40.81l195.61 195.6a28.86 28.86 0 0040.8 0l194.69-194.69a28.86 28.86 0 000-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 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" >
Home
< span class = "md-nav__icon md-icon" > < / span >
< / label >
< a href = "." class = "md-nav__link md-nav__link--active" >
Home
< / 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 = "#how-does-it-work" class = "md-nav__link" >
How does it work?
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#what-are-the-benefits-of-using-rapids" class = "md-nav__link" >
What are the benefits of using RAPIDS?
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#how-is-it-organized" class = "md-nav__link" >
How is it organized?
< / 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-2" type = "checkbox" id = "nav-2" >
< 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" >
< a href = "file-structure/" class = "md-nav__link" >
File Structure
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "setup/installation/" class = "md-nav__link" >
Installation
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "setup/configuration/" class = "md-nav__link" >
2020-12-02 23:28:00 +01:00
Configuration
2020-11-09 18:42:20 +01:00
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "setup/execution/" class = "md-nav__link" >
Execution
< / 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" >
Example Workflows
< span class = "md-nav__icon md-icon" > < / span >
< / label >
< nav class = "md-nav" aria-label = "Example Workflows" data-md-level = "1" >
< label class = "md-nav__title" for = "nav-3" >
< span class = "md-nav__icon md-icon" > < / span >
Example Workflows
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "workflow-examples/minimal/" class = "md-nav__link" >
Minimal
< / a >
< / li >
2020-12-03 18:51:21 +01:00
< li class = "md-nav__item" >
< a href = "workflow-examples/analysis/" class = "md-nav__link" >
Analysis
< / a >
< / li >
2020-11-09 18:42:20 +01:00
< / 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-foreground/" class = "md-nav__link" >
Phone Applications Foreground
< / 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 >
2020-11-26 01:43:05 +01:00
< li class = "md-nav__item" >
< a href = "features/phone-data-yield/" class = "md-nav__link" >
Phone Data Yield
< / a >
< / li >
2020-11-09 18:42:20 +01:00
< 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-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 >
2020-11-19 18:31:39 +01:00
< 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-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 >
2020-11-23 22:53:20 +01:00
< li class = "md-nav__item" >
< a href = "features/fitbit-sleep-summary/" class = "md-nav__link" >
Fitbit Sleep Summary
< / a >
< / li >
2020-11-19 18:31:39 +01:00
< 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 >
2020-11-09 18:42:20 +01:00
< 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" >
2020-12-04 22:22:17 +01:00
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" >
2020-11-09 18:42:20 +01:00
Developers
< span class = "md-nav__icon md-icon" > < / span >
< / label >
< nav class = "md-nav" aria-label = "Developers" data-md-level = "1" >
2020-12-04 22:22:17 +01:00
< label class = "md-nav__title" for = "nav-6" >
2020-11-09 18:42:20 +01:00
< 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/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 >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item md-nav__item--section md-nav__item--nested" >
2020-12-04 22:22:17 +01:00
< input class = "md-nav__toggle md-toggle" data-md-toggle = "nav-7" type = "checkbox" id = "nav-7" >
2020-11-09 18:42:20 +01:00
2020-12-04 22:22:17 +01:00
< label class = "md-nav__link" for = "nav-7" >
2020-11-09 18:42:20 +01:00
Others
< span class = "md-nav__icon md-icon" > < / span >
< / label >
< nav class = "md-nav" aria-label = "Others" data-md-level = "1" >
2020-12-04 22:22:17 +01:00
< label class = "md-nav__title" for = "nav-7" >
2020-11-09 18:42:20 +01:00
< span class = "md-nav__icon md-icon" > < / span >
Others
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
2020-12-04 00:59:04 +01:00
< li class = "md-nav__item" >
2020-12-04 03:05:25 +01:00
< a href = "migrating-from-old-versions/" class = "md-nav__link" >
Migrating from beta
2020-12-04 00:59:04 +01:00
< / a >
< / li >
2020-11-30 19:51:58 +01:00
< li class = "md-nav__item" >
< a href = "code_of_conduct/" class = "md-nav__link" >
Code of Conduct
< / a >
< / li >
2020-11-09 18:42:20 +01:00
< li class = "md-nav__item" >
< a href = "faq/" class = "md-nav__link" >
2020-12-04 03:05:25 +01:00
FAQ
2020-11-09 18:42:20 +01:00
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "team/" class = "md-nav__link" >
Team
< / a >
< / li >
2020-12-04 22:22:17 +01:00
< li class = "md-nav__item" >
< a href = "change-log/" class = "md-nav__link" >
Change Log
< / a >
< / li >
2020-11-09 18:42:20 +01:00
< li class = "md-nav__item" >
< a href = "citation/" class = "md-nav__link" >
Citation
< / a >
< / li >
< / ul >
< / nav >
< / li >
< / ul >
< / nav >
< / div >
< / div >
< / div >
< div class = "md-sidebar md-sidebar--secondary" data-md-component = "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-scrollfix >
< li class = "md-nav__item" >
< a href = "#how-does-it-work" class = "md-nav__link" >
How does it work?
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#what-are-the-benefits-of-using-rapids" class = "md-nav__link" >
What are the benefits of using RAPIDS?
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#how-is-it-organized" class = "md-nav__link" >
How is it organized?
< / a >
< / li >
< / ul >
< / nav >
< / div >
< / div >
< / div >
< div class = "md-content" >
< article class = "md-content__inner md-typeset" >
< a href = "https://github.com/carissalow/rapids/edit/master/docs/index.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 = "welcome-to-rapids-documentation" > Welcome to RAPIDS documentation< a class = "headerlink" href = "#welcome-to-rapids-documentation" title = "Permanent link" > ¶ < / a > < / h1 >
2020-12-04 22:35:08 +01:00
< p > Reproducible Analysis Pipeline for Data Streams (RAPIDS) allows you to process smartphone and wearable data to < a href = "features/feature-introduction/" > extract< / a > and < a href = "features/add-new-features/" > create< / a > < strong > behavioral features< / strong > (a.k.a. digital biomarkers), < a href = "visualizations/data-quality-visualizations/" > visualize< / a > mobile sensor data and < a href = "workflow-examples/analysis/" > structure< / a > your analysis into reproducible workflows.< / p >
2020-11-09 19:24:54 +01:00
< p > RAPIDS is open source, documented, modular, tested, and reproducible. At the moment we support smartphone data collected with < a href = "https://awareframework.com/" > AWARE< / a > and wearable data from Fitbit devices.< / p >
2020-12-04 22:35:08 +01:00
< div class = "admonition tip" >
< p class = "admonition-title" > Tip< / p >
< p > < span class = "twemoji" > < svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M6 15a2 2 0 01-2 2 2 2 0 01-2-2 2 2 0 012-2h2v2m1 0a2 2 0 012-2 2 2 0 012 2v5a2 2 0 01-2 2 2 2 0 01-2-2v-5m2-8a2 2 0 01-2-2 2 2 0 012-2 2 2 0 012 2v2H9m0 1a2 2 0 012 2 2 2 0 01-2 2H4a2 2 0 01-2-2 2 2 0 012-2h5m8 2a2 2 0 012-2 2 2 0 012 2 2 2 0 01-2 2h-2v-2m-1 0a2 2 0 01-2 2 2 2 0 01-2-2V5a2 2 0 012-2 2 2 0 012 2v5m-2 8a2 2 0 012 2 2 2 0 01-2 2 2 2 0 01-2-2v-2h2m0-1a2 2 0 01-2-2 2 2 0 012-2h5a2 2 0 012 2 2 2 0 01-2 2h-5z" / > < / svg > < / span > Questions or feedback can be posted on the #rapids channel in AWARE Framework's < a href = "http://awareframework.com:3000/" > slack< / a > . < / p >
< p > < span class = "twemoji" > < svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M12 2A10 10 0 002 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0012 2z" / > < / svg > < / span > Bugs and feature requests should be posted on < a href = "https://github.com/carissalow/rapids/issues" > Github< / a > . < / p >
2020-11-09 18:42:20 +01:00
< p > < span class = "twemoji" > < svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 512 512" > < path d = "M139.61 35.5a12 12 0 00-17 0L58.93 98.81l-22.7-22.12a12 12 0 00-17 0L3.53 92.41a12 12 0 000 17l47.59 47.4a12.78 12.78 0 0017.61 0l15.59-15.62L156.52 69a12.09 12.09 0 00.09-17zm0 159.19a12 12 0 00-17 0l-63.68 63.72-22.7-22.1a12 12 0 00-17 0L3.53 252a12 12 0 000 17L51 316.5a12.77 12.77 0 0017.6 0l15.7-15.69 72.2-72.22a12 12 0 00.09-16.9zM64 368c-26.49 0-48.59 21.5-48.59 48S37.53 464 64 464a48 48 0 000-96zm432 16H208a16 16 0 00-16 16v32a16 16 0 0016 16h288a16 16 0 0016-16v-32a16 16 0 00-16-16zm0-320H208a16 16 0 00-16 16v32a16 16 0 0016 16h288a16 16 0 0016-16V80a16 16 0 00-16-16zm0 160H208a16 16 0 00-16 16v32a16 16 0 0016 16h288a16 16 0 0016-16v-32a16 16 0 00-16-16z" / > < / svg > < / span > Join our discussions on our algorithms and assumptions for feature < a href = "https://github.com/carissalow/rapids/issues?q=is%3Aissue+is%3Aopen+label%3Adiscussion" > processing< / a > .< / p >
2020-12-02 23:28:00 +01:00
< p > < span class = "twemoji" > < svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 448 512" > < path d = "M424.4 214.7L72.4 6.6C43.8-10.3 0 6.1 0 47.9V464c0 37.5 40.7 60.1 72.4 41.3l352-208c31.4-18.5 31.5-64.1 0-82.6z" / > < / svg > < / span > Ready to start? Go to < a href = "setup/installation/" > Installation< / a > , then to < a href = "setup/configuration/" > Configuration< / a > , and then to < a href = "setup/execution/" > Execution< / a > < / p >
2020-12-04 22:35:08 +01:00
< / div >
2020-11-09 18:42:20 +01:00
< h2 id = "how-does-it-work" > How does it work?< a class = "headerlink" href = "#how-does-it-work" title = "Permanent link" > ¶ < / a > < / h2 >
< p > RAPIDS is formed by R and Python scripts orchestrated by < a href = "https://snakemake.readthedocs.io/en/stable/" > Snakemake< / a > . We suggest you read Snakemake’ s docs but in short: every link in the analysis chain is atomic and has files as input and output. Behavioral features are processed per sensor and per participant.< / p >
< h2 id = "what-are-the-benefits-of-using-rapids" > What are the benefits of using RAPIDS?< a class = "headerlink" href = "#what-are-the-benefits-of-using-rapids" title = "Permanent link" > ¶ < / a > < / h2 >
< ol >
< li > < strong > Consistent analysis< / strong > . Every participant sensor dataset is analyzed in the exact same way and isolated from each other.< / li >
< li > < strong > Efficient analysis< / strong > . Every analysis step is executed only once. Whenever your data or configuration changes only the affected files are updated.< / li >
< li > < strong > Parallel execution< / strong > . Thanks to Snakemake, your analysis can be executed over multiple cores without changing your code.< / li >
2020-12-04 22:35:08 +01:00
< li > < strong > Code-free features< / strong > . Extract any of the behavioral features offered by RAPIDS without writing any code.< / li >
< li > < strong > Extensible code< / strong > . You can easily add your own behavioral features in R or Python, share them with the community, and keep authorship and citations.< / li >
2020-11-09 18:42:20 +01:00
< li > < strong > Timezone aware< / strong > . Your data is adjusted to the specified timezone (multiple timezones suport < em > coming soon< / em > ).< / li >
2020-12-03 00:58:16 +01:00
< li > < strong > Flexible time segments< / strong > . You can extract behavioral features on time windows of any length (e.g. 5 minutes, 3 hours, 2 days), on every day or particular days (e.g. weekends, Mondays, the 1< sup > st< / sup > of each month, etc.) or around events of interest (e.g. surveys or clinical relapses).< / li >
2020-11-09 18:42:20 +01:00
< li > < strong > Tested code< / strong > . We are constantly adding tests to make sure our behavioral features are correct.< / li >
2020-12-04 22:35:08 +01:00
< li > < strong > Reproducible code< / strong > . If you structure your analysis within RAPIDS, you can be sure your code will run in other computers as intended thanks to R and Python virtual environments. You can share your analysis code along your publications without any overhead.< / li >
2020-11-09 18:42:20 +01:00
< li > < strong > Private< / strong > . All your data is processed locally.< / li >
< / ol >
< h2 id = "how-is-it-organized" > How is it organized?< a class = "headerlink" href = "#how-is-it-organized" title = "Permanent link" > ¶ < / a > < / h2 >
2020-12-04 22:35:08 +01:00
< p > In broad terms the < code > config.yaml< / code > , < a href = "../setup/configuration/#database-credentials" > < code > .env< / code > file< / a > , < a href = "../setup/configuration/#participant-files" > participants files< / a > , and < a href = "../setup/configuration/#time-segments" > time segment files< / a > are the only ones that you will have to modify. All data is stored in < code > data/< / code > and all scripts are stored in < code > src/< / code > . For more information see RAPIDS’ < a href = "file-structure/" > File Structure< / a > .< / p >
2020-11-09 18:42:20 +01:00
< / article >
< / div >
< / div >
< / main >
< footer class = "md-footer" >
< div class = "md-footer-nav" >
< nav class = "md-footer-nav__inner md-grid" aria-label = "Footer" >
< a href = "file-structure/" 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 >
File Structure
< / div >
< / div >
< div class = "md-footer-nav__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 >
< 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-insiders/" 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 >
< script src = "assets/javascripts/vendor.12f39d2a.min.js" > < / script >
< script src = "assets/javascripts/bundle.d371fdb2.min.js" > < / script > < script id = "__lang" type = "application/json" > { "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" } < / script >
< script >
app = initialize({
base: ".",
features: ['navigation.sections', 'search.suggest', 'search.highlight'],
search: Object.assign({
worker: "assets/javascripts/worker/search.0f64ce30.min.js"
}, typeof search !== "undefined" & & search),
version: {'method': 'mike'}
})
< / 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 >
2020-11-19 00:31:28 +01:00
< script src = "javascripts/extra.js" > < / script >
2020-11-09 18:42:20 +01:00
< / body >
< / html >
