Skip to content

DouglasNeuroInformatics/ODC_Instruments

Repository files navigation

ODC Instruments

A collection of open-access data-collection instruments for the Open Data Capture platform. Forms live in lib/forms and interactive tasks live in lib/interactive, with each instrument in its own directory containing an index.ts entrypoint.

What is an instrument?

An instrument is the unit of data collection in Open Data Capture — it defines what the user sees, what data is produced, and how that data is validated. See the instruments documentation for a full overview. For guidance on authoring instruments in this repo, see AGENTS.md.

Installation

This repo uses pnpm. Install dependencies with:

pnpm install

You can setup an agents file with the following command:

pnpm exec instrument-guidelines --file CLAUDE.md

Serving an instrument

Use serve-instrument to preview an instrument locally. Pass the instrument's directory as the target:

pnpm exec serve-instrument lib/forms/GAD_7

The dev server runs on port 3000 by default; override it with -p <number>.

Linting

Type-check and lint the instruments with:

pnpm lint

Examples

Browse live examples of instruments on our playground: https://playground.opendatacapture.org

Licensing

This repository is for open-access instruments only. Every instrument must use an approved license — see the list of approved instrument licenses. If you are unsure whether a license qualifies, please open an issue rather than guessing.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors