Skip to content

TRO offers a vocabulary to publish information about relations that should be more transparent, usually between powerful parties

License

Notifications You must be signed in to change notification settings

mikel-egana-aranguren/Transparent-Relations-Ontology

Repository files navigation

License DOI Quality Widoco

Transparent Relations Ontology

About

Transparent Relations Ontology (TRO) offers a vocabulary to publish information about relations that should be more transparent, usually between powerful parties, to detect potential conflicts of interests: for example, governments and their providers, or politicians and their personal relationships. Research journalism and Open Data are two areas in which this sort of data is growing, and new methods and standards are needed to cope with the (FAIR) publication and consumption of such data.

TRO provides the vocabulary for the following projects:

Related projects:

HTTP Access

TRO has a persistent URI thanks to W3ID:

Best practices

Feel free to contribute in any way, with pull requests, issues, etc. We try to follow the best practices from Best Practices for Implementing FAIR Vocabularies and Ontologies on the Web and other resources as described in the guidelines bellow.

Development

We loosely stick to GitFlow and Semantic Versioning so basically:

  • Work on a feature_* branch listing the changes in the RELEASES.md file under the section ## Changes (No release yet).
  • When are you are done merge (No fast forward) feature_* into develop, preferably with a pull request.
  • To create a release after major changes:
    • Change the owl:priorVersion to the current version; owl:versionInfo, owl:versionIRI and owl:schemaVersion values to the version that will be released.
    • Make sure all Quality tests pass (See "Ontology quality" section bellow).
    • Create the documentation (See "Documentation" section bellow).
    • Merge (No fast forward) from develop to a new release_* branch and edit the RELEASES.md file changing ## Changes (No release yet) to the release number (e.g. ## RELEASE 0.1.2) and adding any new changes to the list that were made in the develop branch.
  • Merge (No fast forward) release_* to main (With a pull request) and develop.
  • If a major version bump has happened, create both a release and a tag in GitHub pointing to the commit in main resulting from pulling release_*.

Ontology quality

The main OWL file in Turtle lives at development/TransparentRelationsOntology.ttl, and it is produced using Protégé.

The quality is checked by executing different tests:

  • ROBOT processes that are defined in a Makefile (robot/Makefile):
    • Report: this is based on SPARQL queries that are collected in an specific profile (robot/tro_report_profile) with their respective log level (Error, Warn, Info). To execute locally (Specially to see the HTML report generated), run make report --directory ./robot.
    • Verify is used to define quality rules as SPARQL queries, see for example robot/verify-comment.rq. To execute locally run make verify --directory ./robot
    • Reason applies automatic inference to the ontology, which is used in this case to simply ensure the ontology is consistent. To execute locally, run make reason --directory ./robot.
  • OQuaRE metrics report, based on the OQuaRE framework, in oquare/.

A GitHub actions workflow checks the quality after every push or pull request to develop with changes in the development/ directory as defined in the GitHub Actions YAML file: .github/workflows/quality.yml (If you want to skip quality checks, add [skip actions] to the commit message). Important note: every time OQuaRE is executed new files appear in GitHub, so pull to your local repo regularly.

Documentation

The documentation is generated by the Docker version of Widoco. Execute widoco.sh: it will take development/TransparentRelationsOntology.ttl as input and it will generate the HTML files in release/.

About

TRO offers a vocabulary to publish information about relations that should be more transparent, usually between powerful parties

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages