Skip to content

Latest commit

 

History

History
64 lines (45 loc) · 3.32 KB

File metadata and controls

64 lines (45 loc) · 3.32 KB

Experiments Framework Documentation

This documentation is implementation-first and tracks current behavior in this repository.

Getting Started

  • User Guide: Installation, running locally, creating configs, deploying to JATOS, adding a new task.

Core References

  • Core Framework API: Exhaustive reference for @experiments/core utilities.
  • Configuration & Inheritance: Deep dive into the merge system, runtime overrides, variable resolution, and instruction slots.
  • EEG Workflow: Local EEG bridge, optional LSL, and optional LabRecorder remote control.

Task Adapters

Shared Modules

These components can be integrated into any compatible task adapter via task.modules:

Reference

Most Common Recipes

?config=<taskId>/<file> loads a config directly without needing it registered in the task manifest — prefer this for development. ?variant=<id> is a shortcut for configs already listed in the task's variants[] manifest.

# Start dev server
npm run dev

# Run tasks using config path (works for any bundled config, no registration needed)
http://localhost:5173/?task=nback&config=nback/default
http://localhost:5173/?task=nback&config=nback/pm_module_demo
http://localhost:5173/?task=bricks&config=bricks/spotlight
http://localhost:5173/?task=stroop&config=stroop/default
http://localhost:5173/?task=matb&config=matb/default
http://localhost:5173/?task=rdk&config=rdk/default

# Add auto-responder (no keyboard input needed — good for smoke-testing)
http://localhost:5173/?task=stroop&config=stroop/default&auto=true

# Override individual config keys at runtime (URL-encoded JSON)
http://localhost:5173/?task=nback&config=nback/default&overrides=%7B%22mapping%22%3A%7B%22targetKey%22%3A%22k%22%7D%7D

# Export planned stimulus list without running
http://localhost:5173/?task=nback&config=nback/default&exportStimuli=true