Document direction of AgentHierarchicalRelation, AgentTemporalRelation and others (who is the parent, the source or the target ?)

ICA-EGAD / RiC-O

ICA Records in Contexts-Ontology (ICA RiC-O) GitHub repository web pages

https://ica-egad.github.io/RiC-O/

47 stars 17 forks source link

Document direction of AgentHierarchicalRelation, AgentTemporalRelation and others (who is the parent, the source or the target ?) #38

Closed tfrancart closed 7 months ago

tfrancart commented 1 year ago

I know the comment indicates a direction : "Connects at least one Agent to at least another Agent, when the first one is hierarchically superior to the second one." but this does not obviously translate to the source/target properties.

Could this be made more explicit by adding a sentence e.g. "The relation is oriented to the "bottom" of the hierarchical tree, the Agent that is the source of the relation is the parent, and the Agent that is the target of the relation is the child"

This would avoid or at least ease a few headhaches...

florenceclavaud commented 1 year ago

Hi @tfrancart, OK, that's noted; if you think it would be clear, this will be done in RiC-O 1.O! This improvement should be done for any Relation class as a matter of fact.

florenceclavaud commented 7 months ago

Hi @tfrancart, here are my suggestions on this:

when the Relation is not oriented: we could just add a sentence to its rdfs:comment, saying "This Relation is not oriented", or for some upper level Relations, "This Relation is a generic, not oriented one."
when the Relation connects at least two entities that do not belong to the same class (e.g. a Record and an Agent): we could simply add to the sentence in the rdfs;comment, where they should be, the following 2 expressions: '(as the source of the Relation)' and '(as the target of the Relation');
when the Relation connects at least two entities that belong to the same class (e.g. two Instantiations): we could add the expressions suggested above, + a sentence specifying how the Relation is oriented. E.g. "The Relation is oriented from the parent to the child."

This is what I have typed in this Excel file, generated from RiC-O 1.0-beta, - see column C.

What do you think?

tfrancart commented 7 months ago

Thanks for this proposal, that's great. For improved legibility I propose to move the "source / target" indication at the end of the definition, so that the first sentence remains only conceptual. See proposed Excel table with modified definitions, column D : RelationClassesSpec_withNewDefinitions_TF.xlsx

e.g. "Connects at least one Record Resource or Instantiation to at least one Activity, when the Record Resource or Instantiation results from the Activity. The Record Resource(s) or Instantiation(s) is the source of the Relation, and the Activity(-ies) is the target."

florenceclavaud commented 7 months ago

Thanks for this proposal, that's great. For improved legibility I propose to move the "source / target" indication at the end of the definition, so that the first sentence remains only conceptual. See proposed Excel table with modified definitions, column D : RelationClassesSpec_withNewDefinitions_TF.xlsx

e.g. "Connects at least one Record Resource or Instantiation to at least one Activity, when the Record Resource or Instantiation results from the Activity. The Record Resource(s) or Instantiation(s) is the source of the Relation, and the Activity(-ies) is the target."

OK thanks! I will take your proposal as the basis.

florenceclavaud commented 7 months ago

OK that's done; see this branch: https://github.com/ICA-EGAD/RiC-O/tree/38-document-direction-of-n-ary-Relation-classes. I will soon merge the concerned #89 PR.

florenceclavaud commented 7 months ago

Completed with #89