Research Package

research_package shows surveys and informed consent flows in a Flutter app and returns the participant's answers as structured results. It is a Flutter implementation of Apple's ResearchKit. You define a task as a list of steps, and the package shows one screen per step on Android and iOS.

The package is part of CARP and works in any Flutter app. In a CARP Mobile Sensing (CAMS) study, carp_survey_package turns these tasks into app tasks and stores their results as measurements. See Survey Sampling Package.

Features

Requirements

The Android and iOS minimums come from the video_player plugin, which plays videos in instruction steps. To ask for permissions in a consent flow, your app adds a plugin such as permission_handler, which brings its own requirements. See Permissions.

How it works

flowchart LR
    Task["<b>Task</b><br/>an RPOrderedTask<br/>with its steps"] --> UI["<b>RPUITask</b><br/>one screen per step"]
    UI -->|onSubmit| App["<b>Your app</b><br/>receives one<br/>RPTaskResult"]

The flow has three stages:

1. Your app builds a task: an RPOrderedTask with a list of steps, in which each question step has an answer format.
2. RPUITask shows the steps one screen at a time and records a result for each step that collects an answer.
3. After the last step, RPUITask calls onSubmit with one RPTaskResult and closes its route.

A task with one slider question, shown on a new route:

final task = RPOrderedTask(
  identifier: 'stressCheck',
  steps: [
    RPQuestionStep(
      identifier: 'stressNow',
      title: 'How stressed do you feel right now?',
      answerFormat: RPSliderAnswerFormat(
        minValue: 0,
        maxValue: 10,
        divisions: 10,
      ),
    ),
    RPCompletionStep(
      identifier: 'done',
      title: 'Thank you',
      text: 'Your answer is saved.',
    ),
  ],
);

Navigator.of(context).push(
  MaterialPageRoute<void>(
    builder: (_) => RPUITask(
      task: task,
      onSubmit: (RPTaskResult result) => print(jsonEncode(result)),
    ),
  ),
);

Next steps