Skip to content

The Annotation Module

The annotation module lets you describe important attributes of items not covered by the default set of properties.

annotation panel with 2 annotations
Annotations Panel
The panel shows 2 recorded annotations, a cell type and an antibody type

While item properties are meant to be universally relevant within a given category or sub-category, annotations are more flexible, and let you describe aspects relevant to you or your group.

Every item can be annotated assigning to a defined annotation property (free text or controlled vocabulary, when applicable).

For instance, one can annotate an antibody with its type (e.g. monoclonal, polyclonal). Types are controlled terms that are proposed via a dropdown

annotation panel in edit mode
Annotations Panel when Edit Mode is activated
When edit mode is on, a new annotation can be added. The type can be selected *via* a first dropdown (top, here displaying Applicable Organism). The value to associate with the type is to be selected in a second dropdown (here displaying Select Option). Already registered annotations (bottom) can be modified using the associated dropdown or removed clicking on the trash icon

Note

Annotations are saved immediately (without actively having to save the changes).

Custom annotations

The need for annotation

Let's imagine you adopted a system using different tube colors to organize your antibody collection.

Since this information is pretty irrelevant for other groups, your admin should not add a new "Tube color" property visible to all but rather create a new "Tube color" annotation type that will allow you to track this information in LabID.

Adding a new annotation type (Admin)

Admins can easily add a new annotation type. If you need a new annotation type, simply get in touch with your LabID admin and provide:

  • a name
  • a value type (free text, number, date, user, controlled vocabulary...)
  • a multiplicity (single or multiple values)
  • a textual description of this annotation type that will be used as a help (tooltip)

You might also need to provide your admin with the list of controlled vocabulary if this value type is chosen.