Skip to main content
Version: 0.22.2

Annotate

Annotate lets you assign more user-friendly descriptions to columns in a dataset. Annotate can be especially useful for columns with ambiguous or cryptic names to help yourself and others in your organization work with your data more easily.

Format

Annotate uses three utterances:

  • Annotate the column <column name> in the dataset <dataset name> as <description>
  • Annotate all the columns in the dataset <dataset name> using the mapping file <annotation file>
  • Annotate all the columns in the dataset <dataset name> using the mapping file <annotation file> cleaning previous annotations

Parameters

Annotate uses the following parameters:

  • column name (required). The column to annotate.
  • dataset name (required). The dataset from which the column(s) belong.
  • annotation (required). The annotation you'd like to add.
  • annotation file (required). A separate file containing three columns: Column, Description, and Synonym.
note

Column is the original column name, Description is the user-facing description of the column, and Synonym is the new column name others in your organization can use.

Output

If the annotation is successful, a success message is shown in the chat box and the annotation appears in the display panel. If you have existing annotations on these columns, DataChat will ask if you'd like to overwrite the existing annotations.

Otherwise, an error message is shown in the chat box.

Examples

Consider the dataset Titanic:

To add an annotation to a single column, enter Annotate the column Pclass in the dataset Titanic as PassengerClass

To add an annotation to all the columns, enter Annotate all the columns in the dataset Titanic using the mapping file ColumnNames.csv

To add an annotation to all the columns and overwrite previous annotations, enter Annotate all the columns in the dataset Titanic using the mapping file ColumnNames.csv clearing previous annotations