Skip to content

Latest commit

 

History

History
37 lines (28 loc) · 3.8 KB

README-IntroToBeiwe.md

File metadata and controls

37 lines (28 loc) · 3.8 KB

Beiwe logo

Beiwe Research Platform (www.beiwe.org)

The Beiwe Research Platform is an open-source digital phenotyping platform designed for the collection and analysis of research-grade raw data from smartphone sensors and usage logs. It was developed for biomedical research and funded largely by a 2013 NIH Director’s New Innovator Award to Dr. Jukka-Pekka Onnela at the Harvard T.H. Chan School of Public Health. More than just the Android and iOS apps, the Beiwe Research Platform also consists of three cloud-based components for collecting data, managing studies and performing data analysis which we call the backend. Beiwe was released as open source at the end of 2017 and this document is to help you understand how Beiwe works, what's available and what's planned. For background information, please see https://www.hsph.harvard.edu/onnela-lab/research/ and www.beiwe.org.

Of the Beiwe open source repositories, users need only implement the backend since apps, called Beiwe2, are ready to go on the iOS App Store and the Google Play Store. The Beiwe2 apps will prompt you for your server name & will connect your study participants to the correct study on your platform.

Beiwe consists of five main github repositories as follows.

Repositories

This repository has no code but includes the wiki with the Beiwe documentation.

The Beiwe backend is the AWS-based source code for collecting data, managing studies and performing data analysis. The backend is a modular, scalable system where:

  • studies are created, configured and managed
  • patient IDs are created for enrolling study participants in individual studies
  • surveys, if used, are set up for each study
  • data is collected from all study participants' phones
  • data is analysed if the data analysis pipeline is configured
  • data is downloaded for analysis

The data analysis pipeline infrastructure has not been fully tested at this time but is included in this repo. It is designed to create containers to run specific code from the data analysis pipeline repo on specified studies and is completely configurable to your particular research.

For documentation on the Beiwe back-end and building your own backend server, start here.

For user documentation on Beiwe, start here.

This repository contains the Beiwe Android app code. The Beiwe2 app is also available on the Google Play store to use with open source builds of the Beiwe backend. The Beiwe2 app prompts for your server name and patient IDs from studies on your server.

This repository contains the Beiwe iOS app code. The Beiwe2 app is also available on the Apple App store to use with open source builds of the Beiwe backend. The Beiwe2 app prompts for your server name and patient IDs from studies on your server.

This repository contains an evolving code base for running various types of analyses on data collected with the Beiwe research platform for smartphone-based digital phenotyping. We will merge methods from several distinct projects into this repository by the end of 2018. Note that this repository is distinct from the Beiwe data anlaysis pipeline.

This repository is provided by a doctoral student and contains a set of Python scripts designed to help analyze, and manipulate data generated by the Beiwe application.

Written with StackEdit.