GithubHelp home page GithubHelp logo

saeub / okra Goto Github PK

View Code? Open in Web Editor NEW
1.0 1.0 0.0 1.49 MB

A mobile app for conducting reading comprehension experiments.

Home Page: https://saeub.github.io/okra

License: GNU General Public License v3.0

Kotlin 0.04% Swift 0.12% Objective-C 0.01% Dart 94.90% HTML 1.25% Python 3.68%

okra's People

Contributors

saeub avatar

Stargazers

 avatar

Watchers

 avatar

okra's Issues

Refactoring backlog

  • Consistent use/omission of const in arguments
  • Prefer required keyword arguments over many positional arguments in constructors
  • Doc comments
  • More sane type casting in JSON deserialization
  • Rethink testing without assets (e.g. reaction time task)
  • Increase test coverage
  • Null safety
  • Replace QR package (ML Kit?)
  • Remove stopwatch?
  • Fix stretched loading animation on AboutListTile
  • Somehow prevent passing mutable objects as data when logging (logged values must be frozen); having to remember to put .toList() every time is not very nice (see b9594ad)
  • Organize imports (relative within package, sorted)
  • Use ApiError.retriable to consistently show retriable/unretriable error messages
  • Use final instead of var whenever possible (good reason)
  • Rename subtask to trial
  • Put default/initial values for stateful widgets in field definition or constructor, use initState only if access context is required

Gamification

  • Sound effects (control or record volume settings)
  • Graphics / animations on results page
  • Temporary high score for repeated tasks

Integration testing

  • Update and extend integration tests
  • Make them work in CI/CD
  • Automatically take screenshots and upload them every release (see here or here)

Optional feedback for all tasks

Tasks should always be configurable to give the participant (immediate) feedback about correct and incorrect answers, but it should never be enforced. Currently, feedback is only supported for lexical-decision.

API/client versioning

Think about backwards-compatibility. Communicate versions between API and client. Have clients reject APIs with incompatible versions.

What happens when a client or an API is upgraded?

Pilot study release checklist

All of these need to be done before the pilot study:

  • Two stages in question answering (only text → rating → text + questions)
  • Translate practice indicator
  • Don't show ratings for practice tasks
  • Better spacing in question answering (and larger hitbox?)
  • Display context-aware message after finishing practice task
  • Show participant ID in API settings
  • Show loading animation while finishTask request hasn't finished
  • Back button on instructions screen
  • Don't enforce portrait mode for reaction time task (but lock orientation?)
  • Make emoticon order in ratings configurable
  • Use package_info_plus
  • Fix Markdown scrolling performance issues → postponed until relevant
  • Also store task results locally and have some way to access them, just to be safe → let's just risk it

Practice tasks

Support an optional practice task per experiment.

  • The practice task should be mandatory (at least) before the first task is started, and optionally replayable before any task.
  • The task data should probably be included in the Experiment model.
  • Might want to send results to the API anyway, even though it's a practice task.

Experiment configuration data

Add configuration at the Experiment level for settings that apply to all tasks (e.g. readingType, showQuestionMark).

More configurability:

  • Button labels in lexical decision task
  • Number of Likert items

Retry mode for question answering task

Require users to correct their answers until they are correct, measure number of retries.

As in Laban et al. (2021) (p. 8):

When submitting answers, participants received feedback on which were incorrect, and were required to re-submit until all answers were correct. This aligns the objective of the participant (i.e., finishing the task rapidly), with the task’s objective (i.e., measuring participant’s efficiency at understanding). This also gives a way to discourage participants from “brute-forcing” the task, re-submitting many combinations until one works.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.