How to build vocabulary


To create a new vocabulary, start by clicking on the 'create vocabulary' icon in the Controlled Vocabularies dashboard and provide a name for your vocabulary.

You can build your vocabulary manually by clicking the 'add some' 

Alternatively, you can import an existing vocabulary (that was built outside of the tool) by clicking the 'import' button  in the middle or right panel. 

Panel for creating a new controlled vocabulary, with a highlighter section on the left and a middle panel as the starting point for building the vocabulary.



You can import two types of files:

  • JSON format: Here, you have the option to upload not only terms but also "term code" and 'Synonyms.'

  •  CSV format: In this format, you should place parent terms in the first column and child terms in the second column. Please refer to the example below for clarification. 

Note: You should have a headers for each column or leave the first row empty. You can add as many levels as you need in your vocabulary. 


There are two options for importing when a controlled vocabulary already exists and you decide to modify it:

  • You can add new terms to the existing vocabulary (append).
  • You can completely replace the current vocabulary with a new one.


Tab for uploading CSV or JSON files of vocabulary terms to the controlled vocabulary panel




Screenshot from the Excel file with the example of controlled vocabulary to be imported into the Laser AI.



To create Create/edit vocabulary terms

1. Click 'Add some' to input your first term.

Controlled vocabulary panel with no vocabulary terms and the first step in building controlled vocabulary highlighted - Click 'Add some' in the centre panel.



2. Provide the term in the Edit panel.

3.  If desired, you can define a term code and add synonyms. 


Why is it worth adding synonyms? When you enable model suggestions for this vocabulary field, the model will find the specified terms (one of the synonyms) in the study and extract the main value (vocabulary term). This helps support the model with coding, so you won’t have to manually code the extracted value yourself.


 Controlled vocabulary panel with no vocabulary terms and highlighted second and third steps in vocabulary building highlighted - enter term in the edit panel and define a term code and add synonyms if desired.

4. To add a new term that belongs to a previously provided category, click 'add child' To add a new term that does not belong to previously added terms, click 'add sibling’.

Controlled Vocabulary panel with fourth vocabulary building step highlighted - To add a term under a category, click 'Add Child'. To add a term outside existing categories, click 'Add Sibling'.



5. To rearrange terms within the same vocabulary level, use the 'move up' or 'move down' buttons. To change a term's level, such as from children to parent, use the 'promote' or 'demote' buttons.

Controlled vocabulary panel with fifth step of vocabulary building highlighted - To rearrange terms within the same vocabulary level, use the 'Move items' button



6. And finally, you can also add labels to each parent and child category, which will be used as field names in data extraction forms. In our example, we create two labels: Parent: Study Type Category, and Children: Study Type. In the Data Extraction Form Creator module, when you create your data extraction fields, the tool will automatically add the field name once you choose to use this vocabulary in your data extraction form. 


Controlled vocabulary panel with sith step of vocabulary building highlighted - To create labels for data extraction form


Data extraction form module displaying how labels added in controlled vocabularies are applied when creating a vocabulary field in the data extraction form.



RELATED ARTICLES

  1. Adding suggested terms to vocabulary  

  2. LASER AI ‘Ready to use ’Controlled vocabularies’  

  3. How to extract data in a vocabulary field  

  4. Cleaning extracted data  










Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article