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

Improve FAIRness scores #39

Open
27 tasks
DiegoVinasco opened this issue Feb 13, 2023 · 0 comments
Open
27 tasks

Improve FAIRness scores #39

DiegoVinasco opened this issue Feb 13, 2023 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation technical

Comments

@DiegoVinasco
Copy link
Contributor

DiegoVinasco commented Feb 13, 2023

Looks like we're failing miserably at FAIRness standards (at least outside of interoperability)

The proposed CityGML 3.0 core ontology scored 23% on the FOOPS validator. Below is a breakdown of the results:

Ontology Findable Accessible Interoperable Reusable
CGML3 core 0/9 1.5/3 3/3 1/9

Some of these issues are due to the limitations of hosting on Github. For example, we can't host a URL that can resolve into an HTML document based on an HTTP request.

Many issues have to do with metadata that could be easy to add.

For some reason, the validator is not picking up the fact we are generating SKOS documentation for all of our declared classes and properties, which would raise our reusability.

Some things we can do to improve the score are:

  • register ontology uris with w3id, purl, DOI or W3C
  • make ontology uris the same as their github raw content url
    • although this is technically a minor pitfall in OOPS, this is likely impossible to avoid when using Github
    • we could try storing our ontology files without a file type?
  • properly add version uris
  • add triple metadata! at minimum:
    • title
    • description
    • license (make sure the license declaration actually resolves for bonus points)
    • version iri
    • creator
    • author *
    • creationDate *
    • namespace URI
  • declare a prefix in each ontology
  • register metadata with LOV:
    • ontology prefix
    • ontology URL/URI
    • minimum metadata (same as above)
  • add other metadata such as:
    • doi
    • previous version *
    • contributor *
    • publisher *
    • logo
    • backwards compatibility
    • status
    • modified
    • source
    • issued date *

* provenance metadata: this is worth bonus point in FAIR assessments

Originally posted by @DiegoVinasco in #19 (comment)

@DiegoVinasco DiegoVinasco self-assigned this Feb 13, 2023
@DiegoVinasco DiegoVinasco added documentation Improvements or additions to documentation technical labels Feb 13, 2023
@DiegoVinasco DiegoVinasco mentioned this issue Feb 13, 2023
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation technical
Projects
None yet
Development

No branches or pull requests

1 participant