rapids/docs/index.md

Welcome to RAPIDS documentation

!!! warning The functionality outlined in these docs is implemented in the branch time_segments which we will merge to master soon as release 0.1. The previous (first) release of RAPIDS along with the old docs will be labeled beta. If you landed on this page feel free to look around, just have in mind that we are polishing the last rough patches before we advertise 0.1 (Nov 16, 2020)

Reproducible Analysis Pipeline for Data Streams (RAPIDS) allows you to process smartphone and wearable data to extract behavioral features (a.k.a. digital biomarkers/phenotypes).

RAPIDS is open source, documented, modular, tested, and reproducible. At the moment we support smartphone data collected with AWARE and wearable data from Fitbit devices.

:material-slack: Questions or feedback can be posted on #rapids in AWARE Framework's slack.

:material-github: Bugs should be reported on Github.

:fontawesome-solid-tasks: Join our discussions on our algorithms and assumptions for feature processing.

:fontawesome-solid-play: Ready to start? Go to Installation, then to Configuration, and then to Execution

How does it work?

RAPIDS is formed by R and Python scripts orchestrated by Snakemake. 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.

What are the benefits of using RAPIDS?

1. Consistent analysis. Every participant sensor dataset is analyzed in the exact same way and isolated from each other.
2. Efficient analysis. Every analysis step is executed only once. Whenever your data or configuration changes only the affected files are updated.
3. Parallel execution. Thanks to Snakemake, your analysis can be executed over multiple cores without changing your code.
4. Extensible code. You can easily add your own behavioral features in R or Python and keep authorship and citations.
5. Timezone aware. Your data is adjusted to the specified timezone (multiple timezones suport coming soon).
6. Flexible time segments. 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 1st of each month, etc.) or around events of interest (e.g. surveys or clinical relapses).
7. Tested code. We are constantly adding tests to make sure our behavioral features are correct.
8. Reproducible code. 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.
9. Private. All your data is processed locally.

How is it organized?

In broad terms the config.yaml, .env file, participants files, time segment files are the only ones that you will have to modify. All data is stored in data/ and all scripts are stored in src/. For more information see RAPIDS' File Structure.