back Download and import

Learn more on how you can download a label tree and use it elsewhere.

To download a label tree, press the Download button in the label tree overview. This will start the download of the label tree export file. The label tree export file can be useful in many scenarios. You can use it to publish the label tree on platforms like Zenodo so it gets a DOI and can accompany one of your publications. You can also use the export file to import the label tree in another BIIGLE instance.

To import a label tree from an export file, first click the Create Label Tree button on your dashboard. Next, click the Import button in the create label tree view. In the next view, you can select the export file of the label tree that you wish to import. Click Import to upload the file and perform the import. Label trees that already exist in a BIIGLE instance cannot be imported again. You can fork the label tree in this case.

Label tree export format

A label tree export file is a ZIP archive that contains two files, label_tree.json and labels.csv.

label_tree.json

This is a JSON file that contains the following properties of the label tree:

• id: The ID of the label tree in the BIIGLE database.
• name: The name of the label tree.
• description: The description of the label tree. May be empty.
• created_at: The date and time when the label tree was created.
• updated_at: The date and time when the label tree was last modified.
• uuid: The globally unique identifier of the label tree (UUID4).
• version: An object that contains the id, name and doi of the version of the label tree. This is null if the label tree has no version.

Example:

{
    "id": 240,
    "name": "CATAMI",
    "description": "The CATAMI classification scheme.",
    "created_at": "2019-06-13 08:55:41",
    "updated_at": "2019-06-13 09:20:30",
    "uuid": "620b4105-124e-43a8-af43-16964a9fa192",
    "version": {
        "id": 122,
        "name": "v1.4",
        "doi": "10.5281/zenodo.3374162"
    }
}

labels.csv

This is a CSV file that contains a list of all labels of the label tree. The CSV file has the following columns:

1. id: The ID of the label in the BIIGLE database.
2. name: The name of the label.
3. parent_id: The ID of the parent label of this label. The ID must match one of the IDs in the first column. May be empty if the label has no parent.
4. color: The RGB color code of the label in hex notation.
5. label_tree_id: The ID of the label tree to which the label belongs. This must match the ID of the label tree in label_tree.json.
6. source_id: An arbitrary identifier of the label in an external database like WoRMS. May be empty.

Example:

id	name	parent_id	color	label_tree_id	source_id
17402	Acorn	17412	e70411	240
17406	Articulated calcareous	17553	52bef9	240
17407	Ascidians	17418	d7ea4b	240
17408	Attached	17640	21f68d	240
17409	Bacterial mats	17418	69f0ba	240
17410	Balls	17556	1430ec	240
17411	Barnacle plates	17417	f3c064	240
17412	Barnacles	17472	dbf249	240
17417	Biologenic	17583	4739f1	240
17418	Biota		38ed82	240
...	...	...	...	...	...