mario-bermonti / cognitive_data

Package to simplify managing data from flutter apps that collect data from scientific studies. Particular emphasis on data from cognitive tasks.

TODO: Put a short description of the package here that helps potential users know whether this package might be useful for them.

Features

TODO: List what your package can do. Maybe include images, gifs, or videos.

Getting started

TODO: List prerequisites and provide or point to information on how to start using the package.

Usage

TODO: Include short and useful examples for package users. Add longer examples to /example folder.

const like = 'sample';

Additional information

TODO: Tell users more about the package: where to find more information, how to contribute to the package, how to file issues, what response they can expect from the package authors, and more.

cognitive_data's Issues

Add capability of using Firebase

🚀 Feature Request

Many studies, especially ILD/EMA studies, will need to upload to the cloud.

Add toJson and fromJson methods to base models

🚀 Feature Request

Add toJson and fromJson methods to trial, device, and session base models.

🔈 Motivation

Will facilitate sending data to the Firebase and working with other DB implementations.

Use firebase methods instead of full path as string to reference collections

🚀 Change that should be made

Use firebase methods for accessing collections and documents instead of specifying the full path
using a string.

🔈 Motivation

Specifyign the full path using a string has proven harder to maintain.

Fix format of date times

🐛 Bug Report

We need to use a more universally usable date-time format to facilitate exchanging data with other software, especially for data analysis (e.g., R, python).

• DriftDB uses unix time (e.g., 1714580489) for start and end times.

Organize firebase data primarily by cognitive task and not by participant

🚀 Feature Request

Will require implementing the following structure:
cognitive_measures/
$task_name/
participants/
$participantID/
sessions/
$sessionID/
trials/

🔈 Motivation

This structure aligns better with how cognitive data is typically organized in our studies.

Bump cognitive_data to v0.2.0

Improve name of data objects

🚀 Feature Request

Improve the name of data objects (e.g., session) and how they are named/stored in dbs.

🔈 Motivation

Some names can be shorten.

Fix Release drafter

🚀 Recommendations for improving the ci checks

It is not working because the name used for the "base branch" is main, but "master" is used in this gh action.

Fix issues with release drafter gh action

🚀 Recommendations for improving the ci checks

Update the action

🔈 Motivation

The package does not throw an error, but warnings appear that indicates to update the package.

Handle timestamps for trials

🚀 Feature Request

Trial objects should handle timestamps indicating start and end time.

🔈 Motivation

This will allow calculating response times for trials.

Use the newly implemented toJson() when preparing data for Firebase

🚀 Change that should be made

Use newly created .toJson() method for base models when preparing data in FirebaseDB.

🔈 Motivation

Will improve readability and maintainability.

Implement method to add a list of trials.

🚀 Feature Request

Implement method to add a list of trials.

🔈 Motivation

This would follow drift best practices of using batches to process collections of objects and would
offer flexibility to users.

Add unit tests for FirebaseDB

🚀 Recommendations for improving the ci checks

Add unit tests for FirebaseDB methods.

Fix dependency versions

🚀 Change that should be made

Solve version of dependencies since there are currently problems with drift and test.

🔈 Motivation

This issue doesn't allow adding building the package or adding new deps.