first version of the documentation of the specification

OSTrails · Apr 8, 2024 · 84e5b49 · 84e5b49
1 parent 1a6da7f
commit 84e5b49
Show file tree

Hide file tree

Showing 41 changed files with 45,870 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -3,6 +3,8 @@
 
 Repository to track the requirements and specifications of FAIR assessment reports.
 
+**Permanent identifier:** [https://w3id.org/ftr#](https://w3id.org/ftr#) (click to see documentation and examples beyond the README file)
+
 **Authors**:  Daniel Garijo, Mark Wilkinson, Rober Huber, Lukas Arnhold, Allyson Lister, Elli Papadopoulou, Leonidas Pispiringas, Neil Chue Hong, Clement Jonquet, Wim Hugo
 
 **Source document**: [https://docs.google.com/document/d/1HusredfHgymRg2ub4L0GnVSRV8IWZvFJyMkE6POejpc/edit?usp=sharing](https://docs.google.com/document/d/1HusredfHgymRg2ub4L0GnVSRV8IWZvFJyMkE6POejpc/edit?usp=sharing), with contributions from an initial modeling by Robert Huber and a [diagram](https://owncloud.tuwien.ac.at/index.php/s/VaGxqnf5MxfDtzz#/files_mediaviewer/dmp-dqv.png) authored by Lukas Arnhold.
@@ -15,7 +17,7 @@ We distinguish four main concepts:
 - **TestResultSet**: A set of FAIR test results, together with their respective metadata. Common metadata may describe the set. For example, if all results where run by a request to the same API.
 - **TestExecutionActivity**: The action carried out by an agent of calling an API in which a test (or set of tests) were run. The result of this activity is either a `TestResult` or a `TestResultSet`.
 
-![diagram](./development/img/FAIRTestResult_diagram_v2.drawio.png "Test result overview")
+![diagram](./development/img/FAIRTestResult_diagram_v3.drawio.png "Test result overview")
 
 ### Example: Describing a single test result
 

diff --git a/development/dev.ttl b/development/dev.ttl
@@ -0,0 +1,268 @@
+@prefix : <https://w3id.org/ftr#> .
+@prefix owl: <http://www.w3.org/2002/07/owl#> .
+@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
+@prefix xml: <http://www.w3.org/XML/1998/namespace> .
+@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
+@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
+@base <https://w3id.org/ftr#> .
+
+<https://w3id.org/ftr#> rdf:type owl:Ontology ;
+                         owl:versionIRI <https://w3id.org/ftr/0.0.1> ;
+                         <http://purl.org/dc/elements/1.1/description> "A vocabulary to define FAIR test results."@en ;
+                         <http://purl.org/dc/elements/1.1/title> "FAIR Test Results vocabulary"@en ;
+                         <http://purl.org/dc/terms/abstract> "A vocabulary to define FAIR test results."@en ;
+                         <http://purl.org/dc/terms/created> "April 8th, 2024"@en ;
+                         <http://purl.org/dc/terms/creator> "Allyson Lister"@en ,
+                                                            "Clement Jonquet"@en ,
+                                                            "Daniel Garijo"@en ,
+                                                            "Elli Papadopoulou"@en ,
+                                                            "Leonidas Pispiringas"@en ,
+                                                            "Lukas Arnhold"@en ,
+                                                            "Mark Wilkinson"@en ,
+                                                            "Neil Chue Hong"@en ,
+                                                            "Rober Huber"@en ,
+                                                            "Wim Hugo"@en ;
+                         <http://purl.org/dc/terms/license> <http://creativecommons.org/licenses/by/2.0/> ;
+                         <http://purl.org/dc/terms/source> "https://docs.google.com/document/d/1HusredfHgymRg2ub4L0GnVSRV8IWZvFJyMkE6POejpc/edit?usp=sharing"^^xsd:anyURI ,
+                                                           "https://raw.githubusercontent.com/OSTrails/FAIR_assessment_output_specification/main/cqs/cqs.csv"^^xsd:anyURI ;
+                         <http://purl.org/vocab/vann/preferredNamespacePrefix> "ftr"@en ;
+                         <http://purl.org/vocab/vann/preferredNamespaceUri> "https://w3id.org/ftr#" ;
+                         owl:versionInfo "0.0.1"@en ;
+                         <https://schema.org/codeRepository> "https://github.com/OSTrails/FAIR_assessment_output_specification"^^xsd:anyURI ;
+                         <https://schema.org/image> "https://ostrails.github.io/FAIR_assessment_output_specification/development/img/FAIRTestResult_diagram_v3.drawio.png"^^xsd:anyURI .
+
+#################################################################
+#    Annotation properties
+#################################################################
+
+###  http://purl.org/dc/elements/1.1/description
+<http://purl.org/dc/elements/1.1/description> rdf:type owl:AnnotationProperty .
+
+
+###  http://purl.org/dc/elements/1.1/title
+<http://purl.org/dc/elements/1.1/title> rdf:type owl:AnnotationProperty .
+
+
+###  http://purl.org/dc/terms/abstract
+<http://purl.org/dc/terms/abstract> rdf:type owl:AnnotationProperty .
+
+
+###  http://purl.org/dc/terms/created
+<http://purl.org/dc/terms/created> rdf:type owl:AnnotationProperty .
+
+
+###  http://purl.org/dc/terms/creator
+<http://purl.org/dc/terms/creator> rdf:type owl:AnnotationProperty .
+
+
+###  http://purl.org/dc/terms/license
+<http://purl.org/dc/terms/license> rdf:type owl:AnnotationProperty .
+
+
+###  http://purl.org/dc/terms/source
+<http://purl.org/dc/terms/source> rdf:type owl:AnnotationProperty .
+
+
+###  http://purl.org/vocab/vann/preferredNamespacePrefix
+<http://purl.org/vocab/vann/preferredNamespacePrefix> rdf:type owl:AnnotationProperty .
+
+
+###  http://purl.org/vocab/vann/preferredNamespaceUri
+<http://purl.org/vocab/vann/preferredNamespaceUri> rdf:type owl:AnnotationProperty .
+
+
+###  https://schema.org/codeRepository
+<https://schema.org/codeRepository> rdf:type owl:AnnotationProperty .
+
+
+###  https://schema.org/image
+<https://schema.org/image> rdf:type owl:AnnotationProperty .
+
+
+#################################################################
+#    Object Properties
+#################################################################
+
+###  http://schema.org/author
+<http://schema.org/author> rdf:type owl:ObjectProperty ;
+                           rdfs:isDefinedBy <http://schema.org/> .
+
+
+###  http://schema.org/contactPoint
+<http://schema.org/contactPoint> rdf:type owl:ObjectProperty ;
+                                 rdfs:isDefinedBy <http://schema.org/> .
+
+
+###  http://www.w3.org/ns/prov#hadMember
+<http://www.w3.org/ns/prov#hadMember> rdf:type owl:ObjectProperty ;
+                                      rdfs:isDefinedBy <http://www.w3.org/ns/prov#> .
+
+
+###  http://www.w3.org/ns/prov#used
+<http://www.w3.org/ns/prov#used> rdf:type owl:ObjectProperty ;
+                                 rdfs:isDefinedBy <http://www.w3.org/ns/prov#> .
+
+
+###  http://www.w3.org/ns/prov#wasAssociatedWith
+<http://www.w3.org/ns/prov#wasAssociatedWith> rdf:type owl:ObjectProperty ;
+                                              rdfs:isDefinedBy <http://www.w3.org/ns/prov#> .
+
+
+###  http://www.w3.org/ns/prov#wasAttributedTo
+<http://www.w3.org/ns/prov#wasAttributedTo> rdf:type owl:ObjectProperty ;
+                                            rdfs:isDefinedBy <http://www.w3.org/ns/prov#> .
+
+
+###  http://www.w3.org/ns/prov#wasDerivedFrom
+<http://www.w3.org/ns/prov#wasDerivedFrom> rdf:type owl:ObjectProperty ;
+                                           rdfs:isDefinedBy <http://www.w3.org/ns/prov#> .
+
+
+###  http://www.w3.org/ns/prov#wasGeneratedBy
+<http://www.w3.org/ns/prov#wasGeneratedBy> rdf:type owl:ObjectProperty ;
+                                           rdfs:isDefinedBy <http://www.w3.org/ns/prov#> .
+
+
+###  http://www.w3.org/ns/prov#wasStartedBy
+<http://www.w3.org/ns/prov#wasStartedBy> rdf:type owl:ObjectProperty ;
+                                         rdfs:isDefinedBy <http://www.w3.org/ns/prov#> .
+
+
+###  https://w3id.org/ftr#definedBy
+:definedBy rdf:type owl:ObjectProperty ;
+           rdfs:domain :TestResult ;
+           rdfs:range :TestSpecification ;
+           rdfs:comment "Property linking a test result with its corresponding test specification"@en ;
+           rdfs:label "defined by" .
+
+
+#################################################################
+#    Data properties
+#################################################################
+
+###  http://schema.org/description
+<http://schema.org/description> rdf:type owl:DatatypeProperty ;
+                                rdfs:isDefinedBy <http://schema.org/> .
+
+
+###  http://schema.org/identifier
+<http://schema.org/identifier> rdf:type owl:DatatypeProperty ;
+                               rdfs:isDefinedBy <http://schema.org/> .
+
+
+###  http://schema.org/license
+<http://schema.org/license> rdf:type owl:DatatypeProperty ;
+                            rdfs:isDefinedBy <http://schema.org/> .
+
+
+###  http://schema.org/name
+<http://schema.org/name> rdf:type owl:DatatypeProperty ;
+                         rdfs:isDefinedBy <http://schema.org/> .
+
+
+###  http://schema.org/softwareVersion
+<http://schema.org/softwareVersion> rdf:type owl:DatatypeProperty ;
+                                    rdfs:isDefinedBy <http://schema.org/> .
+
+
+###  http://schema.org/url
+<http://schema.org/url> rdf:type owl:DatatypeProperty ;
+                        rdfs:isDefinedBy <http://schema.org/> .
+
+
+###  http://schema.org/version
+<http://schema.org/version> rdf:type owl:DatatypeProperty ;
+                            rdfs:isDefinedBy <http://schema.org/> .
+
+
+###  https://w3id.org/ftr#affectedElements
+:affectedElements rdf:type owl:DatatypeProperty ;
+                  rdfs:domain :TestResult ;
+                  rdfs:range xsd:anyURI ;
+                  rdfs:comment "Elements affected by the test execution. For example, if a test assesses whether the contents of a resource comply agains a standard, this property may be used  to indicate which elements within the resource have issues."@en ;
+                  rdfs:label "affected elements"@en .
+
+
+###  https://w3id.org/ftr#completion
+:completion rdf:type owl:DatatypeProperty ;
+            rdfs:domain :TestResult ;
+            rdfs:range xsd:float ;
+            rdfs:label "Percentage value of completion of a test result for a given resource. For example, if the test passes, completion is expected to be 1. Otherwise, completion is a value 0..1."@en ,
+                       "completion"@en .
+
+
+###  https://w3id.org/ftr#log
+:log rdf:type owl:DatatypeProperty ;
+     rdfs:domain :TestResult ;
+     rdfs:range xsd:string ;
+     rdfs:comment "Log associated with the test (if any)"@en ;
+     rdfs:label "log"@en .
+
+
+###  https://w3id.org/ftr#status
+:status rdf:type owl:DatatypeProperty ;
+        rdfs:comment "Status of the test result: pass/fail/unknown"@en ;
+        rdfs:label "status"@en .
+
+
+###  https://w3id.org/ftr#usedAPI
+:usedAPI rdf:type owl:DatatypeProperty ;
+         rdfs:domain :TestExecutionActivity ;
+         rdfs:range xsd:anyURI ;
+         rdfs:comment "API used in a test execution activity (if known)"@en ;
+         rdfs:label "used api"@en .
+
+
+#################################################################
+#    Classes
+#################################################################
+
+###  http://www.w3.org/ns/prov#Activity
+<http://www.w3.org/ns/prov#Activity> rdf:type owl:Class ;
+                                     rdfs:isDefinedBy <http://www.w3.org/ns/prov#> .
+
+
+###  http://www.w3.org/ns/prov#Agent
+<http://www.w3.org/ns/prov#Agent> rdf:type owl:Class ;
+                                  rdfs:isDefinedBy <http://www.w3.org/ns/prov#> .
+
+
+###  http://www.w3.org/ns/prov#Collection
+<http://www.w3.org/ns/prov#Collection> rdf:type owl:Class ;
+                                       rdfs:isDefinedBy <http://www.w3.org/ns/prov#> .
+
+
+###  http://www.w3.org/ns/prov#Entity
+<http://www.w3.org/ns/prov#Entity> rdf:type owl:Class ;
+                                   rdfs:isDefinedBy <http://www.w3.org/ns/prov#> .
+
+
+###  https://w3id.org/ftr#TestExecutionActivity
+:TestExecutionActivity rdf:type owl:Class ;
+                       rdfs:subClassOf <http://www.w3.org/ns/prov#Activity> ;
+                       rdfs:comment "The action carried out by an agent of calling an API in which a test (or set of tests) were run. The result of this activity is either a `TestResult` or a `TestResultSet`."@en ;
+                       rdfs:label "Test execution activity"@en .
+
+
+###  https://w3id.org/ftr#TestResult
+:TestResult rdf:type owl:Class ;
+            rdfs:subClassOf <http://www.w3.org/ns/prov#Entity> ;
+            rdfs:comment "Output of running a test over a resource. A test result also should contain provenance metadata about the process followed to create it. `TestResult`is represented as an extension of `prov:Entity`. A test result points to the corresponding test specification through the `ftr:definedBy` property." ;
+            rdfs:label "Test result"@en .
+
+
+###  https://w3id.org/ftr#TestResultSet
+:TestResultSet rdf:type owl:Class ;
+               rdfs:subClassOf <http://www.w3.org/ns/prov#Collection> ,
+                               <http://www.w3.org/ns/prov#Entity> ;
+               rdfs:comment "A set of FAIR test results, together with their respective metadata. Common metadata may describe the set. For example, if all results where run by a request to the same API"@en ;
+               rdfs:label "Test result set"@en .
+
+
+###  https://w3id.org/ftr#TestSpecification
+:TestSpecification rdf:type owl:Class ;
+                   rdfs:comment "A specification stating what a test should do."@en ;
+                   rdfs:label "Test specification"@en .
+
+
+###  Generated by the OWL API (version 4.5.25.2023-02-15T19:15:49Z) https://github.com/owlcs/owlapi