Annotation Tool

The annotation tool is a React application, developed in TypeScript using a variety of tools including Vite, Cypress, and MUI.

Quickstart | Local Installation | Usage | Testing | License

Quickstart

The staging version of the annotation tool is hosted at https://staging-annotation.netlify.app/.

Local Installation

Building and running

# Install dependencies
$ npm install

# Serve with hot module replacement at localhost:5173
$ npm run dev

# Build for production and launch server
$ npm run build
$ npm run preview

Usage

1. Upload your data table (.tsv) file (and/or data dictionary)
2. Annotate the columns
   • Add/edit the column description
   • Select the data type (categorical or continuous) of the column
   • Map columns to Neurobagel standardized variables
3. Annotate the values of the annotated columns
   • Add/edit levels' description (if column data type is categorical) or units description (if column data type is continuous)
4. Download an annotated version of a BIDS-valid data dictionary for your dataset

Testing

The Annotation tool uses Cypress for integration and component testing, and Vitest for unit testing.

License

The Neurobagel Annotation tool uses the MIT License.