cellannotation / cell-annotation-schema

General, open-standard schema for cell annotations
9 stars 1 forks source link

Tweaking names #30

Closed dosumis closed 8 months ago

dosumis commented 8 months ago

Some of the main key names we use have become confusing

Annotation objects are stored under a key called labelset. Collectively these make up a table of annotations and metadata about them.

"labelset": {
  "type": "array",
  "items": {
    "$ref": "#/definitions/Annotation"

Each annotation is part of a set of annotations with a particular name. Membership is indicated using the field (column header in table representation) cellannotation_setname. Metadata about each set is stored in another table (list of objects) under the key 'cellannotation_setname_metadata'. These names are ugly, confusing - hard to use in discussion and hard to remember.

Suggested simplification:

labelset --> annotations. # This is a nice, explicit description of content. Much less confusing than the current name cellannotation_setname_metadata --> labelsets cellannotation_setname --> labelset # This elides whether a labelset refers to a set of annotations united under a single name or a single annotation, but I think that is OK.