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).


[TASKNAME].score_trials [TASKNAME].summarize


🌎 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.24.tar.gz (51.4 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.24-py3-none-any.whl (43.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: m2c2_datakit-0.1.24.tar.gz
  • Upload date:
  • Size: 51.4 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.24.tar.gz
Algorithm Hash digest
SHA256 683807236c6c2cb0e3ad754cb3d3c3d3db57ceaca5eea19ed80a9adebbee5083
MD5 3f6e81b60ff3bb8e298dda60d7be02b7
BLAKE2b-256 02538ff3968095810e12e7fa59815395405a802f2b79fa206805b22e4938aeba

See more details on using hashes here.

File details

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

File metadata

  • Download URL: m2c2_datakit-0.1.24-py3-none-any.whl
  • Upload date:
  • Size: 43.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.24-py3-none-any.whl
Algorithm Hash digest
SHA256 ea73194f1453c9fac19dd5bf5d662b1c3952d2460ec9ab22ccca6eb8dbd0c467
MD5 ff52e346bee1d449bd71116690904ed2
BLAKE2b-256 0e5bc4bce9e3b20d7185dfeae9396175f6738eb51330e1840e8b5771abf6cc6d

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