1. About Research Package

Naming

We are following Apple's pattern when it comes to naming. There's a prefix ORK (Open Research Kit) before the names of classes, types etc. Following that the object names are starting with the RP prefix which stands for Research Package.

For UI widgets we are using the RPUI (Research Package UI) prefix.

Limitations

Currently Research Package supports only single choice questions.

How to set up a Research Package project

Since Research Package is not yet published to pub, in order to use it you have to clone this repo and add it manually to your pubspec.yaml file

  research_package:
    path: *PATH*/research.package

After you run flutter packages get command you are able to import and start using Research Package. With the following line you have access both to the Model and the UI library of the package.

import 'package:research_package/research_package.dart';

Note that objects starting with RP are part of the Model (e.g. RPConsentDocument) while those which start with RPUI are part of the UI library (e.g. RPUIVisualConsentStep).

Object Structure

This is the first direct appearance of an ORKTask: a protocol which is one of the core organizational units of ResearchKit. Tasks in ResearchKit act as a collection of steps, and an ORKOrderedTask is a common class that implements the ORKTask protocol by presenting its steps in a fixed order.

Result Structure