Skip to content

Commit 37d722a

Browse files
committed
added some use case examples in the README
1 parent 0ecda31 commit 37d722a

16 files changed

+144
-115
lines changed

README.md

+4-30
Original file line numberDiff line numberDiff line change
@@ -17,37 +17,10 @@ Below is a graph showing the quality dimensions covered by KGHeartbeat and the p
1717
![Quality metrics covered by KGHeartbeat](quality_metrics.png)
1818

1919
## Examples
20-
1. [How to choose the right KG to create an application that uses Cultural Heritage data.](#1-how-to-choose-the-right-kg-to-create-an-application-that-uses-cultural-heritage-data)
21-
2. [What are the best 10 KGs in terms of Trust and Dataset dynamicity?](#2-what-are-the-best-10-kgs-in-terms-of-trust-and-dataset-dynamicity)
22-
3. [What are the best KGs for automatic consumption?](#3-what-are-the-best-kgs-for-automatic-consumption)
20+
1. [What are the best KGs for automatic consumption in the context of cultural heritage?](./examples/README.md#1-what-are-the-best-kgs-for-automatic-consumption-in-the-context-of-cultural-heritage)
21+
2. [What are the best 10 KGs in terms of Trust and Dataset dynamicity?](./examples/README.md#2-what-are-the-best-10-kgs-in-terms-of-trust-and-dataset-dynamicity)
22+
3. [What are the best KGs in the context of Linguistic Linked Open Data?](./examples/README.md#3-what-are-the-best-kgs-in-the-context-of-linguistic-linked-open-data)
2323

24-
### 1. How to choose the right KG to create an application that uses Cultural Heritage data.
25-
We can filter the Knowledge Graphs to analyze using appropriate keywords to exclude those that do not interest us. For example we can use the following keywords: museum, library, archive, cultur, heritage, bibliotec, natural, biodiversity, geodiversity. Then the configuration.json file will be configured as follows:
26-
```
27-
{"name": ["museum", "library", "archive", "cultur", "heritage", "bibliotec" "natural", "biodiversity", "geodiversity"], "id": []}
28-
```
29-
Our tool in this case give us the following output:
30-
```
31-
Number of KG found with keyword cultur:118
32-
Connection to API successful and data recovered
33-
Number of KG found with keyword heritage:50
34-
Connection to API successful and data recovered
35-
Number of KG found with keyword bibliotec:18
36-
Connection to API successful and data recovered
37-
Number of KG found with keyword natural:67
38-
Connection to API successful and data recovered
39-
Number of KG found with keyword biodiversity:11
40-
Connection to API successful and data recovered
41-
Number of KG found with keyword geodiversity:0
42-
```
43-
And then the analysis phase begins (Be careful, given the large number of KGs, this may take a long time to complete, depending on the load of the servers hosting the KG and your internet connection). At the end of the analysis we will be able to visualize the quality of the KGs analyzed through the csv file produced in the [Analysis results](/Analysis%20results/) folder, having as its name the date of execution of the analysis.
44-
45-
46-
### 2. What are the best 10 KGs in terms of Trust and Dataset dynamicity?
47-
48-
49-
50-
### 3. What are the best KGs for automatic consumption?
5124

5225
## License
5326
KGHeartbeat is licensed under the [MIT License](https://opensource.org/license/mit/).
@@ -74,6 +47,7 @@ Or, by a list of ids like this:
7447
{"name": [], "id": ["dbpedia","taxref-ld"]}
7548
```
7649
If instead, you want to analyze all the Knowledge Graphs automatically discoverable from [LODCloud](https://lod-cloud.net/) and [DataHub](https://old.datahub.io/):
50+
<a name="all-kgs-conf"></a>
7751
```
7852
{"name": [], "id": []}
7953
```

docs/_includes/header.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@
7373
<a href="{{ "/quality_dimensions/security" | relative_url }}">1.4 Security</a>
7474
<a href="{{ "/quality_dimensions/performance" | relative_url }}">1.5 Performance</a>
7575
<p>2. Intrinsic</p>
76-
<a href="{{ "/quality_dimensions/accuracy" | relative_url }}">2.1 Accuracy</a>
76+
<a href="{{ "/quality_dimensions/semantic-accuracy" | relative_url }}">2.1 Semantic Accuracy</a>
7777
<a href="{{ "/quality_dimensions/consistency" | relative_url }}">2.2 Consistency</a>
7878
<a href="{{ "/quality_dimensions/conciseness" | relative_url }}">2.3 Conciseness</a>
7979
<p>3. Trust</p>
@@ -88,7 +88,7 @@
8888
<a href="{{ "/quality_dimensions/amount_of_data" | relative_url }}">5.2 Amount of data</a>
8989
<p>6. Representational</p>
9090
<a href="{{ "/quality_dimensions/representational_conciseness" | relative_url }}">6.1 Representational-conciseness</a>
91-
<a href="{{ "/quality_dimensions/representational_consistency" | relative_url }}">6.2 Representational-consistency</a>
91+
<a href="{{ "/quality_dimensions/interoperability" | relative_url }}">6.2 Interoperability</a>
9292
<a href="{{ "/quality_dimensions/understandability" | relative_url }}">6.3 Understandability</a>
9393
<a href="{{ "/quality_dimensions/interpretability" | relative_url }}">6.4 Interpretability</a>
9494
<a href="{{ "/quality_dimensions/versatility" | relative_url }}">6.5 Versatility</a>

0 commit comments

Comments
 (0)