zooniverse / Panoptes-Front-End

Front end for zooniverse/Panoptes
https://www.zooniverse.org
Apache License 2.0
64 stars 76 forks source link

Add schemas for drawing tool annotations #4478

Closed rogerhutchings closed 5 years ago

rogerhutchings commented 6 years ago

Related to #4423

Following on from @mschwamb's Zoominar earlier today, I propose adding JSON schemas for all drawing tools.

  1. For each tool, we create a JSON Schema-compliant spec, which includes a description of each property and a note saying where the origin is.
  2. When a drawing tool is used in the classifier, a copy of the spec for that tool gets appended to the classification object.

This would mean that:

eatyourgreens commented 6 years ago

Adding additional data to the classification exports sounds painful. We're already trying to reduce them in size. Could Caesar get the annotation schema from the workflow?.

mschwamb commented 6 years ago

What about adding a version id and somewhere else the annotation schema is like a wiki/read the docs linked on the project builder export page

mschwamb commented 6 years ago

Could this be added to the workflow contents export so it doesn't bog down the classification export with more stuff? I don't know actually know what the different between the workflow contents export and the workflow export is. The export page in the project builder doesn't really say. Interestingly the drawing tool/type isn't listed in the workflow contents export (e.g. "T1.tools.4.label":"Fan Tool")

I would suggest a version id for marking tools be added (assuming all drawing tools in panoptes are still the original version?) because we had to have that in P4 when the bug in the fan tool was identified well into the project where it was measuring the incorrect angle. You could use the stored info to compute the correct angle, but you needed to know what classifications needed that applied. So a marker version id was added to differentiate between what we had to correct in terms of measuring spread and what was measured with the corrected drawing tool.

eatyourgreens commented 6 years ago

More generally, each task should have a description of its annotations. I'm not sure if that should be a separate issue or incorporated into this one.

@mschwamb the workflow contents export is used by translations and contains the primary language version of your workflow text. At the moment that's English for all workflows. You can see an example of a workflow in two langiages, on a live project, at Snapshot Hoge Veluwe.

stale[bot] commented 5 years ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

mschwamb commented 5 years ago

I do think it's hard for project owners to have to figure out what annotation tool provides, since there isn't documentation. Sending people to the data digging github repo isn't really the answer especially since some of the info isn't update what changes are made.

stale[bot] commented 5 years ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

stale[bot] commented 5 years ago

Closed by probot-stale due to a lack of recent activity. Please feel free to re-open if you wish to take on this change.