This is a Flutter package implementing support for surveys like ResearchStack and ResearchKit.
The main focus at the moment is to make Research Package capable of handling a WHO5 survey.
Currently the focus is on creating a consent flow with the Dart model and Flutter UI widgets.
Also, we are designing and implementing the domain model for ResearchPackage. The package tries to follow the ResearchStack and ResearchKit patterns and namings.
The main modules of the above mentioned libraries are:
- Consent - How it's done in ResearchKit
- Survey - How it's done in ResearchKit
- Active Task - How it's done in ResearchKit
- We can implement these later with the help of flutter plugins by CACHET.
-
ResearchKit
- Official Tutorial on how to use ResearchKit in ObjectiveC You can get a good understading of the flow and the basic concepts. Also there's a useful presentation of the different AnswerFormats.
- Hierarchy of objects in ResearchKit This is a good representation of a possible file/class hierarchy for ResearchPackage.
- Tutorial on how to use ResearchKit in Swift
- Sample Apps for ResearchKit in Swift
-
ResearchStack
ResearchStack and ResearchKit are built on native iOS and Android which have totally different architecture than the Widget-based Flutter. It hopefully doesn't affect the domain model but for wiring up the model to the UI, we should definitely implement a different approach from ResearchKit and Stack.
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. in ResearchKit, so our names are starting with the RP prefix which stands for Research Package.
For UI widgets we are using the RPUI (Research Package UI) prefix.
In order to use Research Package, you have to clone this repo and add it manually to your pubspec.yaml file
research_package:
path: *PATH*/research.packageAfter you run the 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 part of the package.
import 'package:research_package/model.dart';
import 'package:research_package/ui.dart';Remember, that objects starting with RP are part of the Model (like RPConsentDocument) while those which start with RPUI are part of the UI library (like RPUIVisualConsentStep).