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.23.tar.gz (51.3 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.23-py3-none-any.whl (43.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: m2c2_datakit-0.1.23.tar.gz
  • Upload date:
  • Size: 51.3 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.23.tar.gz
Algorithm Hash digest
SHA256 c905700a90c7e22f019342f090d8accf4848f4e1eadb5a4f53f85f4c0f11608b
MD5 2f4c3aaaafbe8905187f8d3f840f96fa
BLAKE2b-256 e37d7dc2a0944cf15edebe149368eef1f32fb4c3f02d4e6ecd944099eeba08e3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: m2c2_datakit-0.1.23-py3-none-any.whl
  • Upload date:
  • Size: 43.6 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.23-py3-none-any.whl
Algorithm Hash digest
SHA256 30a63919847af796077f85e32d59084dc9bc3eab1040670168de1281475e4fb6
MD5 3d1ed4ce8136b880b549fc12d3a78031
BLAKE2b-256 a6e55485d0f07496cbf1b11d87337457848af62016151182bedecdcdaee78eae

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