Skip to content

Commit

Permalink
Towards test metadata descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
dgarijo committed Jul 24, 2024
1 parent 3d5106d commit 60fc537
Show file tree
Hide file tree
Showing 8 changed files with 319 additions and 10 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@ Repository to track the requirements and specifications of FAIR assessment repor
## Core test result representation
We distinguish four main concepts:
- **TestResult**: 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.
- **TestSpecification:** A specification stating what a test should do.
- **Test:** A test (service) implementing a dqv:Metric
- **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_v3.drawio.png "Test result overview")
![diagram](./development/img/FAIRTestResult_diagram_v4.drawio.png "Test result overview")

### Example: Describing a single test result

Expand Down
19 changes: 14 additions & 5 deletions cqs/cqs.csv
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
CQ id,CQ,Terms used to address CQ
CQ1,What is the id for a test result/test set?,"ftr:TestResult, schema:identifier, Text/URL"
CQ2,What is the status of the test result? (pass/fail/other?),"ftr:TestResult, dqv:value, Text/Number"
CQ3,What is the name of the test associated with a test result?,"ftr:TestResult, dqv:isQualityMeasurementOf, schema:name"
CQ4,What is the description of the test associated with a test result?,"ftr:TestResult, dqv:isQualityMeasurementOf, schema:description"
CQ5,What test did this result run?,"ftr:TestResult, dqv:isQualityMeasurementOf, dqv:Metric"
CQ1,What is the id for a test result/test set?,"ftr:TestResult, dcterms:identifier, xsd:anyURI"
CQ2,What is the status of the test result? (pass/fail/other?),"ftr:TestResult, ftr:status, Literal"
CQ3,What is the name of the test associated with a test result?,"ftr:TestResult, ftr:outputFromtest, ftr:Test, dcterms:title"
CQ4,What is the description of the test associated with a test result?,"ftr:TestResult, ftr:outputFromtest, ftr:Test, dcterms:description"
CQ5,What test did this result run?,"ftr:TestResult, ftr:outputFromtest, ftr:Test"
CQ6,Which URL/API was used to obtain this result?,"ftr:TestResult, prov:wasGeneratedBy, ftr:usedAPI"
CQ7,Which tool was run to obtain this result?,"ftr:AssessmentActivity, prov:wasAttributedTo, ftr:AssessmentTool"
CQ8,Which version of the tool was used to obtain a test result?,"ftr:AssessmentTool, schema:softwareVersion, Text"
Expand All @@ -21,3 +21,12 @@ CQ19,"How was a FAIR score computed? (i.e., which test results and metrics were
CQ20,Which quality metrics have been applied to a FAIR score? How are these computed?,Not addressed yet
CQ21,Who do I complain about this test result?,"ftr:TestResult/ftr:TestResultSet, schema:author, prov:Agent"
CQ22,What are the contact details for the person/organization who posted this FAIR test result/ Set of results?,"ftr:TestResultSet, schema:contactPoint, schema:ContactPoint"
CQ23,What is the unique id of a test?,
CQ24,What is the name and url of the organization responsible for this test?,
CQ25,Who created a test?,
CQ26,Who to contact about a test?,
CQ27,What is the description of a test?,
CQ28,What is the indicator associated with a test?,
CQ29,What are the keywords associated with a test?,
CQ30,What is the API URL associated with a test?,
CQ31,"What is the API description of a test? (e.g., OpenAPI description)",
4 changes: 2 additions & 2 deletions development/dev.ttl
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
@base <https://w3id.org/ftr#> .

<https://w3id.org/ftr#> rdf:type owl:Ontology ;
owl:versionIRI <https://w3id.org/ftr/0.0.1> ;
owl:versionIRI <https://w3id.org/ftr/0.0.2> ;
<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 ;
Expand All @@ -27,7 +27,7 @@
"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 ;
owl:versionInfo "0.0.2"@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 .

Expand Down
Loading

0 comments on commit 60fc537

Please sign in to comment.