Skip to content

Commit

Permalink
Merge pull request #139 from juanjemdIos/Fair_Ontologies_New_Test
Browse files Browse the repository at this point in the history
Better metric descriptions and markdown. Issue 135
  • Loading branch information
dgarijo authored Dec 5, 2024
2 parents ff5aa3e + 4c20328 commit be4928c
Show file tree
Hide file tree
Showing 69 changed files with 1,982 additions and 1,253 deletions.
10 changes: 9 additions & 1 deletion doc/metric/DOC1/DOC1.html
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,15 @@ <h1 class="miClase text-center">Metric DOC1</h1>
</div>
</div>
<div class="row">
<div class="col-md-12 well" style="font-size: 18px;"> This metric evaluates the presence and accessibility of HTML documentation, ensuring that users can easily access, read, and understand the structure and content. </div>
<div class="col-md-12 well" style="font-size: 16px;"> <p>This metric evaluates the presence and accessibility of HTML documentation to ensure that users can easily access and understand the resource’s structure and content.</p>
<p><strong>What is being measured?</strong></p>
<p>The availability and quality of HTML documentation for an ontology or resource.</p>
<p><strong>Why should we measure it?</strong></p>
<p>HTML documentation enhances usability, transparency, and accessibility, aligning with FAIR principles.</p>
<p><strong>What must be provided for the measurement?</strong></p>
<p>An ontology URI.</p>
<p><strong>What are considered valid results?</strong></p>
<p>The existence of an accessible, online HTML page providing clear and detailed documentation of the ontology.</p></div>
</div>
<div class="row flex-space-between">
<div class="col-md-12 align-items-center">
Expand Down
56 changes: 28 additions & 28 deletions doc/metric/DOC1/DOC1.jsonld
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
[
{
"@id": "https://w3id.org/foops/test/DOC1",
"@type": [
"https://www.w3id.org/ftr#Test"
]
},
{
"@id": "https://w3id.org/foops/metric/DOC1",
"@type": [
Expand All @@ -15,7 +21,7 @@
"http://purl.org/dc/terms/description": [
{
"@language": "en",
"@value": " This metric evaluates the presence and accessibility of HTML documentation, ensuring that users can easily access, read, and understand the structure and content. "
"@value": " \nThis metric evaluates the presence and accessibility of HTML documentation to ensure that users can easily access and understand the resource’s structure and content.\n\n**What is being measured?**\n\nThe availability and quality of HTML documentation for an ontology or resource.\n\n**Why should we measure it?**\n\nHTML documentation enhances usability, transparency, and accessibility, aligning with FAIR principles.\n\n**What must be provided for the measurement?**\n\nAn ontology URI.\n\n**What are considered valid results?**\n\nThe existence of an accessible, online HTML page providing clear and detailed documentation of the ontology.\n\n\t"
}
],
"http://purl.org/dc/terms/identifier": [
Expand Down Expand Up @@ -118,28 +124,6 @@
}
]
},
{
"@id": "https://orcid.org/0000-0003-0454-7145",
"@type": [
"http://www.w3.org/2006/vcard/ns#Individual"
],
"http://www.w3.org/2006/vcard/ns#fn": [
{
"@value": "Daniel Garijo"
}
],
"http://www.w3.org/2006/vcard/ns#hasEmail": [
{
"@id": "mailto:[email protected]"
}
]
},
{
"@id": "https://oeg.fi.upm.es",
"@type": [
"http://www.w3.org/2006/vcard/ns#Organization"
]
},
{
"@id": "https://w3id.org/fair/principles/terms/R1",
"@type": [
Expand All @@ -163,24 +147,40 @@
]
},
{
"@id": "https://w3id.org/foops/test/DOC1",
"@id": "https://orcid.org/0000-0003-3587-0367",
"@type": [
"https://www.w3id.org/ftr#Test"
"http://www.w3.org/2006/vcard/ns#Individual"
],
"http://www.w3.org/2006/vcard/ns#fn": [
{
"@value": "Maria Poveda"
}
],
"http://www.w3.org/2006/vcard/ns#hasEmail": [
{
"@id": "mailto:[email protected]"
}
]
},
{
"@id": "https://orcid.org/0000-0003-3587-0367",
"@id": "https://oeg.fi.upm.es",
"@type": [
"http://www.w3.org/2006/vcard/ns#Organization"
]
},
{
"@id": "https://orcid.org/0000-0003-0454-7145",
"@type": [
"http://www.w3.org/2006/vcard/ns#Individual"
],
"http://www.w3.org/2006/vcard/ns#fn": [
{
"@value": "Maria Poveda"
"@value": "Daniel Garijo"
}
],
"http://www.w3.org/2006/vcard/ns#hasEmail": [
{
"@id": "mailto:m.poveda@upm.es"
"@id": "mailto:dgarijo@upm.es"
}
]
}
Expand Down
22 changes: 21 additions & 1 deletion doc/metric/DOC1/DOC1.ttl
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,26 @@
<https://w3id.org/foops/metric/DOC1> a dqv:Metric ;
dcterms:identifier <https://w3id.org/foops/metric/DOC1> ;
dcterms:title "HTML availability"@en ;
dcterms:description """ This metric evaluates the presence and accessibility of HTML documentation, ensuring that users can easily access, read, and understand the structure and content. """@en ;
dcterms:description """
This metric evaluates the presence and accessibility of HTML documentation to ensure that users can easily access and understand the resource’s structure and content.
**What is being measured?**
The availability and quality of HTML documentation for an ontology or resource.
**Why should we measure it?**
HTML documentation enhances usability, transparency, and accessibility, aligning with FAIR principles.
**What must be provided for the measurement?**
An ontology URI.
**What are considered valid results?**
The existence of an accessible, online HTML page providing clear and detailed documentation of the ontology.
"""@en ;
rdfs:label "Metric DOC1"^^xsd:string ;
vivo:abbreviation "Metric DOC1"^^xsd:string ;
dcat:contactPoint <https://orcid.org/0000-0003-0454-7145> ;
Expand Down Expand Up @@ -43,3 +62,4 @@
vivo:abbreviation "R1"^^xsd:string ;
dcterms:description "meta(data) are richly described with a plurality of accurate and relevant attributes."@en .


10 changes: 9 additions & 1 deletion doc/metric/FIND1/FIND1.html
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,15 @@ <h1 class="miClase text-center">Metric FIND1</h1>
</div>
</div>
<div class="row">
<div class="col-md-12 well" style="font-size: 18px;"> This benchmark defines criteria to ensure the availability of ontology prefixes. The benchmark verifies that the ontology prefix is registered and accessible, ensuring consistent usage and reference across various datasets and applications.</div>
<div class="col-md-12 well" style="font-size: 16px;"> <p>This metric ensures the availability and accessibility of ontology prefixes. It verifies that the prefix is registered and resolvable, enabling consistent usage across datasets and applications.</p>
<p><strong>What is being measured?</strong></p>
<p>The registration and accessibility of the ontology prefix.</p>
<p><strong>Why should we measure it?</strong></p>
<p>To ensure interoperability and consistent reference in diverse datasets and tools.</p>
<p><strong>What must be provided for the measurement?</strong></p>
<p>An ontology URI.</p>
<p><strong>What are considered valid results?</strong></p>
<p>A registered ontology prefix that resolves correctly and aligns with public registries.</p></div>
</div>
<div class="row flex-space-between">
<div class="col-md-12 align-items-center">
Expand Down
96 changes: 48 additions & 48 deletions doc/metric/FIND1/FIND1.jsonld
Original file line number Diff line number Diff line change
@@ -1,28 +1,4 @@
[
{
"@id": "https://w3id.org/foops/test/FIND1",
"@type": [
"https://www.w3id.org/ftr#Test"
]
},
{
"@id": "https://w3id.org/foops/benchmark/ALL",
"@type": [
"https://www.w3id.org/ftr#Benchmark"
],
"http://purl.org/dc/terms/description": [
{
"@language": "en",
"@value": "This benchmark specifies the criteria for evaluating aspects of data quality according to the FAIR principle. Apply to all metrics."
}
],
"http://purl.org/dc/terms/title": [
{
"@language": "en",
"@value": "General Benchmark ALL for FAIR Principles"
}
]
},
{
"@id": "https://w3id.org/foops/metric/FIND1",
"@type": [
Expand All @@ -39,7 +15,7 @@
"http://purl.org/dc/terms/description": [
{
"@language": "en",
"@value": " This benchmark defines criteria to ensure the availability of ontology prefixes. The benchmark verifies that the ontology prefix is registered and accessible, ensuring consistent usage and reference across various datasets and applications."
"@value": " \nThis metric ensures the availability and accessibility of ontology prefixes. It verifies that the prefix is registered and resolvable, enabling consistent usage across datasets and applications.\n\n**What is being measured?**\n\nThe registration and accessibility of the ontology prefix.\n\n**Why should we measure it?**\n\nTo ensure interoperability and consistent reference in diverse datasets and tools.\n\n**What must be provided for the measurement?**\n\nAn ontology URI.\n\n**What are considered valid results?**\n\nA registered ontology prefix that resolves correctly and aligns with public registries.\n\t"
}
],
"http://purl.org/dc/terms/identifier": [
Expand Down Expand Up @@ -128,18 +104,42 @@
]
},
{
"@id": "https://orcid.org/0000-0003-0454-7145",
"@id": "https://w3id.org/fair/principles/terms/F3",
"@type": [
"http://www.w3.org/2006/vcard/ns#Individual"
"https://w3id.org/fair/principles/terms/FAIR-SubPrinciple"
],
"http://www.w3.org/2006/vcard/ns#fn": [
"http://purl.org/dc/terms/description": [
{
"@value": "Daniel Garijo"
"@language": "en",
"@value": "metadata clearly and explicitly include the identifier of the data it describes"
}
],
"http://www.w3.org/2006/vcard/ns#hasEmail": [
"http://vivoweb.org/ontology/core#abbreviation": [
{
"@id": "mailto:[email protected]"
"@value": "F3"
}
],
"http://www.w3.org/2000/01/rdf-schema#label": [
{
"@value": "F3"
}
]
},
{
"@id": "https://w3id.org/foops/benchmark/ALL",
"@type": [
"https://www.w3id.org/ftr#Benchmark"
],
"http://purl.org/dc/terms/description": [
{
"@language": "en",
"@value": "This benchmark specifies the criteria for evaluating aspects of data quality according to the FAIR principle. Apply to all metrics."
}
],
"http://purl.org/dc/terms/title": [
{
"@language": "en",
"@value": "General Benchmark ALL for FAIR Principles"
}
]
},
Expand All @@ -162,46 +162,46 @@
]
},
{
"@id": "https://oeg.fi.upm.es",
"@id": "https://w3id.org/foops/test/FIND1",
"@type": [
"http://www.w3.org/2006/vcard/ns#Organization"
"https://www.w3id.org/ftr#Test"
]
},
{
"@id": "https://w3id.org/fair/principles/terms/F3",
"@id": "https://orcid.org/0000-0003-3587-0367",
"@type": [
"https://w3id.org/fair/principles/terms/FAIR-SubPrinciple"
],
"http://purl.org/dc/terms/description": [
{
"@language": "en",
"@value": "metadata clearly and explicitly include the identifier of the data it describes"
}
"http://www.w3.org/2006/vcard/ns#Individual"
],
"http://vivoweb.org/ontology/core#abbreviation": [
"http://www.w3.org/2006/vcard/ns#fn": [
{
"@value": "F3"
"@value": "Maria Poveda"
}
],
"http://www.w3.org/2000/01/rdf-schema#label": [
"http://www.w3.org/2006/vcard/ns#hasEmail": [
{
"@value": "F3"
"@id": "mailto:[email protected]"
}
]
},
{
"@id": "https://orcid.org/0000-0003-3587-0367",
"@id": "https://oeg.fi.upm.es",
"@type": [
"http://www.w3.org/2006/vcard/ns#Organization"
]
},
{
"@id": "https://orcid.org/0000-0003-0454-7145",
"@type": [
"http://www.w3.org/2006/vcard/ns#Individual"
],
"http://www.w3.org/2006/vcard/ns#fn": [
{
"@value": "Maria Poveda"
"@value": "Daniel Garijo"
}
],
"http://www.w3.org/2006/vcard/ns#hasEmail": [
{
"@id": "mailto:m.poveda@upm.es"
"@id": "mailto:dgarijo@upm.es"
}
]
}
Expand Down
20 changes: 19 additions & 1 deletion doc/metric/FIND1/FIND1.ttl
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,25 @@
<https://w3id.org/foops/metric/FIND1> a dqv:Metric ;
dcterms:identifier <https://w3id.org/foops/metric/FIND1> ;
dcterms:title "Ontology prefix"@en ;
dcterms:description """ This benchmark defines criteria to ensure the availability of ontology prefixes. The benchmark verifies that the ontology prefix is registered and accessible, ensuring consistent usage and reference across various datasets and applications."""@en ;
dcterms:description """
This metric ensures the availability and accessibility of ontology prefixes. It verifies that the prefix is registered and resolvable, enabling consistent usage across datasets and applications.
**What is being measured?**
The registration and accessibility of the ontology prefix.
**Why should we measure it?**
To ensure interoperability and consistent reference in diverse datasets and tools.
**What must be provided for the measurement?**
An ontology URI.
**What are considered valid results?**
A registered ontology prefix that resolves correctly and aligns with public registries.
"""@en ;
rdfs:label "Metric FIND1"^^xsd:string ;
vivo:abbreviation "Metric FIND1"^^xsd:string ;
dcat:contactPoint <https://orcid.org/0000-0003-0454-7145> ;
Expand Down
14 changes: 13 additions & 1 deletion doc/metric/FIND2/FIND2.html
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,19 @@ <h1 class="miClase text-center">Metric FIND2</h1>
</div>
</div>
<div class="row">
<div class="col-md-12 well" style="font-size: 18px;"> This benchmark defines criteria to ensure the discoverability and consistency of ontology prefixes. The benchmark verifies that the ontology prefix is registered in recognized registries such as prefix.cc or LOV. It also checks that the prefix resolves to the same namespace prefix found in the ontology, ensuring accurate and consistent referencing. </div>
<div class="col-md-12 well" style="font-size: 16px;"> <p>This metric ensures that ontology prefixes are discoverable and consistently aligned with recognized registries. It verifies that the prefix is registered in platforms such as prefix.cc or LOV and resolves to the same namespace as declared in the ontology.</p>
<p><strong>What is being measured?</strong></p>
<p>The registration and resolution of the ontology prefix in trusted registries.</p>
<p><strong>Why should we measure it?</strong></p>
<p>To guarantee accurate and consistent references across datasets and to promote interoperability.</p>
<p><strong>What must be provided for the measurement?</strong></p>
<p>An ontology URI.</p>
<p><strong>What are considered valid results?</strong></p>
<p>The ontology prefix must:</p>
<ul>
<li>Be registered in recognized registries (e.g., prefix.cc, LOV).</li>
<li>Resolve to the same namespace prefix as declared in the ontology.</li>
</ul></div>
</div>
<div class="row flex-space-between">
<div class="col-md-12 align-items-center">
Expand Down
Loading

0 comments on commit be4928c

Please sign in to comment.