The annotation tool is a React application, developed in TypeScript using a variety of tools including Vite, Cypress, and MUI.
Quickstart | Local Installation | Usage | Configuration | Testing | License
The staging version of the annotation tool is hosted at https://staging-annotation.netlify.app/.
# 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- Upload your data table (.tsv) file (and/or data dictionary)
- Annotate the columns
- Add/edit the column description
- Select the data type (categorical or continuous) of the column
- Map columns to Neurobagel standardized variables
- 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)
- Download an annotated version of a BIDS-valid data dictionary for your dataset
The annotation tool is designed to be highly configurable, allowing it to adapt to different research contexts and data standards. You can define your own set of standardized variables and vocabularies to match your specific needs. For detailed technical information about creating and customizing configurations, see the Configuration Guide.
The Annotation tool uses Cypress for integration and component testing, and Vitest for unit testing.
The Neurobagel Annotation tool uses the MIT License.