Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Additional documentation for checking correctness within inside-schema properties #39

Open
aeidi89 opened this issue Sep 15, 2020 · 3 comments
Assignees
Labels
docu improvements or additions to documentation
Milestone

Comments

@aeidi89
Copy link
Collaborator

aeidi89 commented Sep 15, 2020

Here we should comment on the dependency-check between inside-schema properties (property cross-check).
These dependencies are difficult to express within a schema, but they are necessary for the logic of the schema and to be able to use SANDS as we wish.

Example: an annotation is connected on a 1-1 basis with a term for a specific version of a reference atlas. In the brainAtlas schema both the properties annotationSet and terminology will collect annotations (connected to specific anatomicalEntities (connected to a terminology)) and terms (connected to specific annotations). The terminology must match to fullfill the requirements for a brain atlas (a specific brain atlas version cannot have 2 different terminologies).

@aeidi89 aeidi89 self-assigned this Sep 15, 2020
@aeidi89 aeidi89 added the docu improvements or additions to documentation label Sep 15, 2020
@aeidi89 aeidi89 added this to the Documentation milestone Sep 15, 2020
@lzehl
Copy link
Member

lzehl commented Sep 15, 2020

Very nice! Let's keep track of the individual dependencies collectively here. For each dependency scenario/case make sure to reference the corresponding schemas (e.g., via the revision-schema issues).

@UlrikeS91
Copy link
Collaborator

UlrikeS91 commented Sep 15, 2020

anatomicalEntity:

  • source is optional, but is required for being connected to brainAtlas (a brain atlas version has to have a terminology)

  • parentStructure (= another anatomicalEntity) has to have the same source as the child

  • parentStructure allows shaping your own hierarchy, but EBRAINS/HBP goal for SANDS is to capture the atlas structures as they were published --> parentStructure needs to reflect the same hierarchy as the publication dictates

also described in #26

@aeidi89
Copy link
Collaborator Author

aeidi89 commented Sep 17, 2020

Moving property laterality from anatomicalEntity.schema.json to annotation.schema.json (Ref. issue #26)

  • When removing information about laterality from the region (anatomicalEntity) to the annotation we must ensure that bi-lateral regions have two annotations (left and right).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docu improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants