Merge pull request #126 from juanjemdIos/Fair_Ontologies_New_Test

Updated test, metrics, templates and readme

doc/README.md

@@ -5,3 +5,83 @@ The source is always the TTL file, and the result is a HTML file and a JSON-LD f
 
 The main page displays the tests and metrics created from the ttl_transformation.py process, which are stored in doc/test.
 This main page is generated by "https://github.com/oeg-upm/foops_documentation_scripts/ttl_catalog.py"
+
+The process to update any of the tests or metrics would be as follows. After modifying any of the existing properties in the ttl file of the test or metric, it is necessary to first run the Python script ttl_transformation.py and then ttl_catalog.py to ensure that any updated properties are displayed on the main page containing the list of tests and metrics. Both scripts can be found at https://github.com/oeg-upm/foops_documentation_scripts/.
+
+In case it is necessary to add a new property to any of the existing documents, it is essential to include it both in the script ttl_transformation.py, where it should be included in the SPARQL query, and in the function that maps the query results to the template. For tests, this function is called ttl_to_html, while for metrics it is ttl_to_html_metrics.
+
+Additionally, the test or metric template must be modified to include this property and ensure it is displayed in the HTML. In this Mustache template, the mapping is performed and an HTML file is created for each test. The tests use template.html located at https://github.com/oeg-upm/fair_ontologies/tree/main/doc/test/template.html. The metrics use template_metrics.html located at https://github.com/oeg-upm/fair_ontologies/tree/main/doc/metrics/template_metrics.html.
+
+To include a new test or metric from the beginning, its necessary to create a ttl file with the same structure as the other documents and include it in its corresponding folder. For example, if you create the test NEW1.ttl, you need to create a folder NEW1 at https://github.com/oeg-upm/fair_ontologies/tree/main/doc/test/ and place the file NEW1.ttl there.
+
+All test and metric IDs must follow the following structure:
+https://w3id.org/foops/test/
+https://w3id.org/foops/metric/
+
+Therefore, for the example we are following, the ID would be: https://w3id.org/foops/test/NEW1
+
+Then you would run the ttl_transformation.py script, which will generate the HTML file and the JSON-LD file for that test. Afterwards, you would run the ttl_catalog.py script to add this new test to the main page.
+
+Currently, the structure of the TTL file required for a test is as follows:
+
+---
+
+<https://w3id.org/foops/test/NEW1> a ftr:Test ; --> ID
+<http://www.w3.org/ns/dcat/contactPoint> <https://orcid.org/0000-0000-0000-0000> ; --> CREATOR
+dcterms:creator <https://orcid.org/0000-0000-0000-0000> ;
+dcterms:title "Title New1"@en ; --> TITLE TEST
+rdfs:label "NEW1"; --> LABEL
+dcterms:license <http://creativecommons.org/licenses/by/2.0/> ; --> LICENSE
+ftr:indicator <https://w3id.org/fair/principles/terms/R1> ; --> INDICATOR
+dcterms:description """ Description New1 """^^xsd:string ; --> TEST DESCRIPCION
+dcterms:publisher <https://oeg.fi.upm.es> ; --> PUBLISHER
+dcat:version "0.0.1"^^xsd:string ; --> VERSION
+dcterms:identifier <https://w3id.org/foops/test/NEW1> ; --> IDENTIFIER
+dcat:keyword "tags"@en ; --> KEYWORDS
+<http://semanticscience.org/resource/SIO_000233> <https://w3id.org/foops/metric/NEW1> ; --> METRIC RELATE
+doap:repository <https://w3id.org/foops/repository> .
+<https://orcid.org/0000-0000-0000-0000> a vcard:Kind;
+vcard:fn "Name Creator" ;
+vcard:hasEmail <mailto:[email protected]> .
+<https://w3id.org/fair/principles/terms/R1> a <https://w3id.org/fair/principles/terms/FAIR-SubPrinciple> ;
+rdfs:label "indicator"@en ; --> NAME INDICATOR
+dcterms:description "description indicator"@en . --> INDICATOR DESCRIPTION
+<https://oeg.fi.upm.es> a foaf:Organization .
+<https://w3id.org/foops/repository>
+foaf:homePage <https://github.com/oeg-upm/fair_ontologies> . --> REPOSITORY
+<https://w3id.org/foops/metric/NEW1> a dqv:Metric .
+
+---
+
+Metrics has a very similar structure:
+
+---
+
+<https://w3id.org/foops/metric/NEW1> a dqv:Metric ; --> ID
+dcterms:identifier <https://w3id.org/foops/metric/NEW1> ; --> IDENTIFIER
+dcterms:title "TITLE"@en ; --> TITLE
+dcterms:description """ Descripction metric """^^xsd:string ; --> DESCRIPTION
+rdfs:label "Metric NEW1"; --> LABEL
+<http://www.w3.org/ns/dcat/contactPoint> <https://orcid.org/0000-0000-0000-0000> ; --> CREAETOR
+dcterms:creator <https://orcid.org/0000-0000-0000-0000> ;
+dcterms:publisher <https://oeg.fi.upm.es> ; --> PUBLISHER
+dcat:version "0.0.1"^^xsd:string ; --> VERSION
+dcat:keyword "Tags"@en ; --> KEYWORDS
+dqv:inDimension <https://w3id.org/fair/principles/terms/R1> ; --> DIMENSION
+dcat:landingPage <https://w3id.org/foops/metric/NEW1> ; --> LANDING PAGE
+<http://semanticscience.org/resource/SIO_000233> <https://w3id.org/foops/test/NEW1> ; --> TEST RELATE WITH THE METRIC
+ftr:hasBenchmark <https://w3id.org/foops/benchmark/full_assessment> ;
+ftr:metricStatus "Active"@en .
+<https://orcid.org/000-0000-0000-0000> a dcat:Kind;
+vcard:fn "Name Creator" ;
+vcard:hasEmail <mailto:[email protected]> .
+<https://oeg.fi.upm.es> a foaf:Organization .
+<https://w3id.org/foops/test/NEW1> a ftr:Test .
+<https://w3id.org/foops/benchmark/full_assessment> a dav:MetricBenchmark; --> BENCHMARK
+dcterms:title "General Benchmark for FAIR Principles";
+dcterms:description "This benchmark specifies the criteria for evaluating aspects of data quality according to the FAIR principle." .
+<https://w3id.org/fair/principles/terms/R1> a <https://w3id.org/fair/principles/terms/FAIR-SubPrinciple> ;
+rdfs:label "R1"@en ;
+dcterms:description "meta(data) are richly described with a plurality of accurate and relevant attributes."@en .
+
+---