Welcome

The VRLab Toolbox turns raw recordings — physiology signals, VR event logs, and questionnaire answers — into one clean, per-participant data file that's ready for analysis, by running every participant's data through the same fixed sequence of steps: find files, import, process, combine, and save.

Curious why it's built this way before diving in? See Why This Toolbox Exists.

Who this is for

• Just here to run a tool or check some data? Start with Getting Started — no coding background needed. For Users below covers everything from there.
• Changing the code itself? For Contributors below is for you. Look out for Going further boxes throughout those pages — they explain why the pipeline is built the way it is, not just what it does.

Where to go next

Pages are ordered to be read straight through — each one links to the next — but here's the map if you want to jump around.

For everyone: Why This Toolbox Exists — worth reading whether you're running the pipeline or changing it.

For users

Running the tools and understanding what they show you — no code changes, no coding background needed.

• 1. Get set up: Getting Started
• 2. Prepare your data: Crosschecking, FOH Crosscheck, Crane Crosscheck
• 3. Process your data: Process Your Data
• 4. Check your output: EDA & SCRs, FOH Output Checks, Crane Output Checks

For contributors

Changing the code and sharing that change back.

• AI use guidelines: AI Use Guidelines, AI Style Guide
• Set up a dev environment: Development Setup
• Understand the code: Code Organization, Golden Rules
• Understand the architecture: Pipeline Concepts, Design Patterns
• File matching & LSL internals: Pipeline Rules, Lab Streaming (LSL/XDF)
• Data classes: Data Stores, Core Data Classes
• BIDS crosscheck internals: BIDS Crosscheck Architecture
• GitHub guidelines: For Contributors
• Check it works: Testing
• Look things up: API Reference
• Build & release: Building & Releasing

Going further

This site itself is built with MkDocs and the Material theme, and editing it is a contribution like any other. It only builds locally for now — see Code Organization for why, and how to preview it yourself.

Ready? Start with Getting Started.