Skip to main content

Platform overview

RADAR-base is an open source platform for remote data collection in clinical studies: mobile apps and wearables collect data from participants, a streaming backend ingests and processes it, and analysis tools turn it into research output.

RADAR-base logo

This site brings together the documentation for the individual RADAR-base components. Each component's pages are published directly from its own repository, so what you read here is what its maintainers wrote alongside the code, at the version you select.

Alpha

This documentation site is a work in progress. Components are still being added, and some sections are thinner than they will be. If something is missing or wrong, see the FAQ and common issues page for where to raise it.

How this documentation is organised​

  • Platform — cross-component material maintained in the radar-base-docs repository. This section.
  • Components — one section per repository, each with its own version picker. Pages under a released version match that release; the version labelled Next tracks the component's default branch.
  • Client and Participant — the apps, devices and participant-facing guides, maintained on the RADAR-base website and linked from the navigation. See Background reading below.
  • FAQ and common issues — where to ask questions, and the problems that come up most often.

Background reading​

Higher-level material about the platform is published on the RADAR-base website rather than in a repository:

For running a study, the Client menu covers the questionnaire (aRMT) and passive (pRMT) apps, the phone sensors and devices they collect from, and authorising third-party wearable accounts. The Participant menu has the user guide documents written for study participants.

Where to start​

If you are new to RADAR-base, the RADAR-base website covers what the platform does and who uses it. If you are looking to analyse data that has already been collected, start with the RADAR Pipeline documentation from the Components menu. For anything you cannot find, the FAQ lists where RADAR-base questions get answered.

Contributing documentation​

Documentation lives with the code it describes. To publish a repository's documentation here, add a docs/ folder to that repository — see Adding a repository. Corrections to individual pages are best made in the repository that owns them; every page has an "Edit this page" link that takes you to the right file.