Skip to main content

Data management and scoring tools for the M2C2 project

Project description

m2c2-datakit

🚀 A set of R, Python, and NPM packages for scoring M2C2kit Data! 🚀

This is the Python package 🐍

PyPI version

Installation for End Users

  • pip install m2c2-datakit
  • pip3 install m2c2-datakit

Developers:


Changelog

Source: https://github.com/nelsonroque/m2c2kit-data

See CHANGELOG.md


Features

Current Features

  1. Load a JSON file of a query export from MongoDB
  2. Load a folder of JSON files, one folder per participant, with subfolders for sessions, from Metricwire
  3. Interoperable Data exports (csv, tsv, pkl)

Feature Roadmap

  1. In General: Feature and Data parity from R, Python, and NPM scoring tools (same data + different tool = same scores)
  2. CLI in Python for simplifying scoring with one-liners (e.g., m2data --score --summarise --file data.json)
  3. Load a folder of JSON files, one folder per participant, with subfolders for sessions, from REDCAP (Coming Soon)
  4. Load a file export, containing columns for each trial, for each task, from Qualtrics (Coming Soon)

🚀 Getting Started

Installation for Scoring Developers

# 1. Create the virtual environment
pip install uv # or pip3 install uv
uv venv .venv

# 2. Activate the virtual environment
source .venv/bin/activate  # macOS/Linux
# .venv\Scripts\Activate    # Windows (PowerShell)

# 3. Install dependencies
uv pip install -e .

# 4. Run formatting, linting, and type checking
make install

💡 Contributions Welcome!

📌 Have ideas? Found a bug? Want to improve the package? Open an issue!.

📜 Code of Conduct - Please be respectful and follow community guidelines.


Acknowledgements

The development of m2c2-datakit was made possible with support from NIA (1U2CAG060408-01).


🌎 More Resources:
📌 M2C2 Official Website 📌 M2C2kit Official Documentation Website 📌 Pushing to PyPI


🚀 Let's go study some brains!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

m2c2_datakit-0.1.20.tar.gz (50.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

m2c2_datakit-0.1.20-py3-none-any.whl (41.9 kB view details)

Uploaded Python 3

File details

Details for the file m2c2_datakit-0.1.20.tar.gz.

File metadata

  • Download URL: m2c2_datakit-0.1.20.tar.gz
  • Upload date:
  • Size: 50.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.6

File hashes

Hashes for m2c2_datakit-0.1.20.tar.gz
Algorithm Hash digest
SHA256 5233125260292b441713492e5c0bfa0c162056f7b529aacb5d382f93060132f1
MD5 09ee5b0e450000caea1d47a0daf70d5d
BLAKE2b-256 f0fccd419836ca522092dd7929ebd6e220e4c6392b20b8c7e060fa8c5e8bc04e

See more details on using hashes here.

File details

Details for the file m2c2_datakit-0.1.20-py3-none-any.whl.

File metadata

  • Download URL: m2c2_datakit-0.1.20-py3-none-any.whl
  • Upload date:
  • Size: 41.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.6

File hashes

Hashes for m2c2_datakit-0.1.20-py3-none-any.whl
Algorithm Hash digest
SHA256 c236f042bd247e6e7f2e59ece2eceb9cddd180a9c502f2ec2cf43c0237f0764f
MD5 d4b20f45f1952177bccce4c55beda0c0
BLAKE2b-256 82a2409300de68e0310bec0eb4174ce2e1d954aa329431d5b204c1de507072f1

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page