feat(building-comparison): add link to data source to plot

* feat(building-comparison): add link to data source to plot

* chore: refactoring and add changelog

CHANGELOG.md

@@ -12,6 +12,7 @@
 
 - building-comparison: AOI is now clipped to the coverage area ([#739])
 - mapping-saturation: add hover info to estimated total data line ([#723])
+- building-comparison: now has link to reference datasets ([#741])
 
 ### Other Changes
 
@@ -20,6 +21,7 @@
 
 [#723]: https://github.com/GIScience/ohsome-quality-api/pull/723
 [#739]: https://github.com/GIScience/ohsome-quality-api/pull/739
+[#741]: https://github.com/GIScience/ohsome-quality-api/pull/741
 
 
 ## Release 1.0.2

COPYRIGHTS.md

@@ -53,4 +53,4 @@ Please have a look at the API response field `attribution` to figure out which o
     - ODbL: Default (95+%)
     - CC-BY-SA: Prague (v0_1-CZE_11-OTHER-LICENSE-CC-BY-SA.zip)
     - CC-BY-NC: Abruzzo (v0_1-ITA_1-OTHER-LICENSE-CC-BY-NC.zip)
-Citation: `Milojevic-Dupont, N., Wagner, F., Nachtigall, F. et al. EUBUCCO v0.1: European building stock characteristics in a common and open database for 200+ million individual buildings. Sci Data 10, 147 (2023). https://doi.org/10.1038/s41597-023-02040-2`
+- Citation: `Milojevic-Dupont, N., Wagner, F., Nachtigall, F. et al. EUBUCCO v0.1: European building stock characteristics in a common and open database for 200+ million individual buildings. Sci Data 10, 147 (2023). https://doi.org/10.1038/s41597-023-02040-2`

ohsome_quality_api/indicators/building_comparison/indicator.py

@@ -13,6 +13,10 @@
 from ohsome_quality_api.ohsome import client as ohsome_client
 from ohsome_quality_api.topics.models import BaseTopic
 
+SOURCE_LINKS = {
+    "EUBUCCO": "https://docs.eubucco.com/",
+}
+
 
 class BuildingComparison(BaseIndicator):
     def __init__(
@@ -134,8 +138,9 @@ def create_figure(self) -> None:
 
         fig.update_layout(title_text=("Building Comparison"), showlegend=True)
         fig.update_yaxes(title_text="Building Area [km²]")
-        fig.update_xaxes(title_text="Datasets")
-
+        fig.update_xaxes(
+            title_text="Datasets (" + get_sources(self.area_references.keys()) + ")"
+        )
         raw = fig.to_dict()
         raw["layout"].pop("template")  # remove boilerplate
         self.result.figure = raw
@@ -171,3 +176,11 @@ def check_minor_edge_cases(self) -> str:
             )
         else:
             return ""
+
+
+def get_sources(reference_datasets):
+    sources = ""
+    for dataset in reference_datasets:
+        if dataset in SOURCE_LINKS.keys():
+            sources += f"<a href='{SOURCE_LINKS[dataset]}'>{dataset}</a>"
+    return sources

tests/integrationtests/indicators/test_building_comparison.py

@@ -8,6 +8,7 @@
 
 from ohsome_quality_api.indicators.building_comparison.indicator import (
     BuildingComparison,
+    get_sources,
 )
 from tests.integrationtests.utils import oqapi_vcr
 
@@ -203,3 +204,8 @@ def test_create_figure_building_area_zero(
         assert isinstance(indicator.result.figure, dict)
         assert indicator.result.figure["data"][0]["type"] == "bar"
         pgo.Figure(indicator.result.figure)
+
+
+def test_get_sources():
+    source = get_sources(["EUBUCCO"])
+    assert source == "<a href='https://docs.eubucco.com/'>EUBUCCO</a>"