sweet icon indicating copy to clipboard operation
sweet copied to clipboard

ISSUE-110 Add additional types of variables to repr.ttl

Open lewismc opened this issue 7 years ago • 11 comments

This PR addresses #110

I also noticed that data was missing for representations of dimensions e.g. 1D, 2D and 3D which had all been changed to D somehow...

lewismc avatar Feb 03 '19 22:02 lewismc

Any comments @ESIPFed/semtech

lewismc avatar Feb 13 '19 07:02 lewismc

SWEET has many cases where "what was meant" can not be discerned from the content (witness the discussion of 'sample'); I think this is one of those. In which case it's on us to figure out what would be most useful.

I believe that a 1D representation in SWEET is a class descriptor for all the 1D lines in the world (at least, all the 1D lines that follow the 'Representation' class constraints). I do not think these should be individuals in SWEET.

I agree that '1D' is a poor name. I would like to see it deprecated in favor of something like 'one-dimensional representation', appropriately camel-cased and de-spaced and de-hyphened as needed to match SWEET.

And yes, changing anything to an individual will mean certain repositories ( looking at you BioPortal) will no longer present it in the UI. But I don't think that should affect the decision-making process, and it didn't affect the recommendation I made above.

graybeal avatar Feb 13 '19 19:02 graybeal

Let me address these issues and update the PR folks. We can take it from there. Thanks for the input.

lewismc avatar Feb 13 '19 19:02 lewismc

In addition to providing the additional types of variable and accomodating descriptions for all variables now included within repr.ttl, I updated the PR to essentially deprecate the 1D, 2D and 3D classes replacing them with Classes bearing the string literal name. I have not yet addressed the instances vs classes issue highlighted by @carueda. I am going to hold off on the provision of an rdfs:comment before we address that issue.

lewismc avatar Feb 13 '19 23:02 lewismc

I do want to note that the Class naming issue we've identified above is more widespread across SWEET. Take the following

http://sweetontology.net/reprSpaceGeometry/GeometricalObject_0D
http://sweetontology.net/reprSpaceGeometry/GeometricalObject_1D
http://sweetontology.net/reprSpaceGeometry/GeometricalObject_2D
http://sweetontology.net/reprSpaceGeometry/GeometricalObject_3D
http://sweetontology.net/reprDataModel/Swath_2D
http://sweetontology.net/reprDataModel/Swath_3D
http://sweetontology.net/reprSpaceGeometry3D
http://sweetontology.net/reprMath/Vector_3D
http://sweetontology.net/relaSpace/hasCommon2DBorderWith

There is more work to be done here...

lewismc avatar Feb 14 '19 00:02 lewismc

I'm not sure it's as bad as all that. If you accept the theory that these are types of representations, then there is no need to change the classes to individuals.

And in this case the '2D' or '3D' or whatever does not have to be spelled out IMHO, because the context is much more apparent. The problem with standalone '1D', '2D', etc. is that it omitted the fact these were representations. So a better suggestion than my previous is Representation_1D, which would match these other forms.

Except SpaceGeometry3D, which clearly needs an underscore before 3D.

graybeal avatar Feb 14 '19 01:02 graybeal

OK @graybeal I'll update based on this.

lewismc avatar Feb 14 '19 02:02 lewismc

@lewismc As John notes, those do look like classes. Take for example GeometricalObject_1D; it makes sense to have statements like ex:fooObj a GeometricalObject_1D, ex:baz a GeometricalObject_1D, etc.

By contrast, as already noted above, one wouldn't be creating instances of repr:1D . The point with repr:0D, repr:1D, ..., is that they already represent the concrete concepts of 0-dimensionality, 1-dimensionality, .... With the repr:Dimensionality class already in SWEET, we may want to consider introducing these concrete dimensionality concepts with statements like repr:D0 a repr:Dimensionality, repr:D1 a repr:Dimensionality (along with any additional statements --eg., restrictions-- to further characterize such concept).

carueda avatar Feb 14 '19 02:02 carueda

OK @graybeal I've updated based on your suggestions. I wanted to make the following reply however

Except SpaceGeometry3D, which clearly needs an underscore before 3D.

This is a file IRI not a Class IRI. I would like to suggest that we limit the impact of changing the file IRI by adhering to the following

  • FIle IRI's follow UpperCamelCaseWithNoUnderScore
  • Class IRI's follow UpperCamelCaseWithUnderscoresFor_Numbers

What do you think?

lewismc avatar Feb 14 '19 03:02 lewismc

@carueda thanks for the comments. I think we should address this in a separate ticket to keep things separate.

lewismc avatar Feb 14 '19 03:02 lewismc

Tempted to close this ticked off and to resubmit the suggested fix in a separate PR... however I want to clarify what our approach is to the several issues mentioned above.

lewismc avatar Jul 16 '19 17:07 lewismc