CellMLAnnotationView Plugin

The CellMLAnnotationView plugin can be used to annotate CellML files. If you open a CellML file which does not contain any annotation, then it will look something like this:

CellMLAnnotationView plugin: default view

All the CellML elements which can be annotated are listed to the left of the view. If you right click on any of them, you will get a popup menu which you can use to expand/collapse all the child nodes, as well as remove the metadata associated with the current CellML element or the whole CellML file:

CellMLAnnotationView plugin: context menu

Annotate a CellML element

Say that you want to annotate the sodium_channel component. First, you need to select it:

CellMLAnnotationView plugin: select a CellML element

Next, you need to specify a BioModels.net qualifier. If you do not know which one to use, click on the applications-internet button to get some information about the current BioModels.net qualifier:

CellMLAnnotationView plugin: select a BioModels.net qualifier

From there, go through the list of BioModels.net qualifiers until you find the one you are happy with. Here, we will use bio:isVersionOf:

CellMLAnnotationView plugin: select bio:isVersionOf as a qualifier

Now, you need to retrieve some possible ontological terms to describe the sodium_channel component. For this, you must enter a search term which in our case is going to be sodium channel (note: regular expressions are supported). As can be seen, OpenCOR returns 12 possible ontological terms:

CellMLAnnotationView plugin: list of possible ontological terms

A quick look through the list tells us that you might want to use the one for voltage-gated sodium channel complex. If you want to know more about the GO resource, you can click on its corresponding link:

CellMLAnnotationView plugin: look up some resource information

Similarly, if you want to know more about the GO identifier:

CellMLAnnotationView plugin: look up some identifier information

Now that you are happy with your choice of ontological term, you can associate it with the sodium_channel component by clicking on its corresponding list-add button:

CellMLAnnotationView plugin: associate an ontological term with a CellML element

As you will have seen, the ontological term you have just added cannot be added anymore, but it can be removed by clicking on its corresponding list-remove button or by using the context menu (see above).

Now, say that you also want to add the next ontological term. You can obviously do so by clicking on the corresponding list-add button, but you could also enter its resource-id duple, e.g. go/GO:0005248 (i.e. <resource>/<id>) in the term field. Indeed, OpenCOR will recognise this 'term' as being a a resource-id duple and will offer you to add its corresponding ontological term directly:

CellMLAnnotationView plugin: directly associate an ontological term with a CellML element

Unrecognised annotations

Annotations consist of RDF triples which are made of a subject, a predicate and an object. OpenCOR recognises RDF triples which subject identifies a CellML element while it expects the predicate to be a BioModels.net qualifier and the object an ontological term.

Ontological terms used to be identified using MIRIAM URNs, but these have now been deprecated in favour of identifiers.org URIs. OpenCOR recognises both, but it will only serialise annotations using identifiers.org URIs.

Now, it may happen that a file contains annotations that are not recognised by OpenCOR. In this case, OpenCOR will display the annotations as a simple list of RDF triples:

CellMLAnnotationView plugin: unrecognised annotations

If you ever come across a type of annotations which you think OpenCOR ought to recognise, but does not, then please do contact us.