Progress measure

.gitignore

@@ -112,3 +112,5 @@ venv.bak/
 # IDEs
 .vscode
 .DS_Store
+.idea
+*.ipynb

sdg/IndicatorOptions.py

@@ -12,6 +12,7 @@ def __init__(self):
         ]
         self.series_column = 'Series'
         self.unit_column = 'Units'
+        self.progress_column = 'Progress'
         self.observation_attributes = []
 
 
@@ -51,3 +52,11 @@ def set_unit_column(self, column):
 
     def get_unit_column(self):
         return self.unit_column
+
+    def set_progress_column(self, column):
+        self.progress_column = column
+        return self
+
+
+    def get_progress_column(self):
+        return self.progress_column

sdg/open_sdg.py

@@ -203,6 +203,7 @@ def open_sdg_indicator_options_defaults():
             'Series',
             'Value',
             'GeoCode',
+            'Progress',
             'Observation status',
             'Unit multiplier',
             'Unit measure',
@@ -218,6 +219,7 @@ def open_sdg_indicator_options_defaults():
         ],
         'series_column': 'Series',
         'unit_column': 'Units',
+        'progress_column': 'Progress',
     }
 
 
@@ -233,6 +235,8 @@ def open_sdg_indicator_options_from_dict(options):
         options_obj.set_series_column(options['series_column'])
     if 'unit_column' in options:
         options_obj.set_unit_column(options['unit_column'])
+    if 'progress_column' in options:
+        options_obj.set_progress_column(options['progress_column'])
     return options_obj
 
 
@@ -358,6 +362,7 @@ def open_sdg_prep(options):
         logging=options['logging'],
         indicator_export_filename=options['indicator_export_filename'],
         ignore_out_of_scope_disaggregation_stats=options['ignore_out_of_scope_disaggregation_stats'],
+        cache_store = {},
     )
 
     if callable(options['alter_indicator']):

sdg/outputs/OutputOpenSdg.py

@@ -3,6 +3,7 @@
 from sdg.outputs import OutputBase
 from sdg.data import write_csv
 from sdg.json import write_json, df_to_list_dict
+from sdg.ProgressMeasure import IndicatorProgress
 
 class OutputOpenSdg(OutputBase):
     """Output SDG data/metadata in the formats expected by Open SDG."""
@@ -11,7 +12,7 @@ class OutputOpenSdg(OutputBase):
     def __init__(self, inputs, schema, output_folder='_site', translations=None,
         reporting_status_extra_fields=None, indicator_options=None,
         indicator_downloads=None, logging=None, indicator_export_filename='all_indicators',
-        ignore_out_of_scope_disaggregation_stats=False):
+        ignore_out_of_scope_disaggregation_stats=False, cache_store=None):
         """Constructor for OutputOpenSdg.
 
         Parameters
@@ -28,6 +29,9 @@ def __init__(self, inputs, schema, output_folder='_site', translations=None,
             A filename (without the extension) for the zipped indicator export.
         ignore_out_of_scope_disaggregation_stats : boolean
             Whether to ignore the "not applicable" disaggregation stats.
+        cache_store : dict
+            A store that is passed in to allow caching during the build, to
+            avoid useless duplication.
         """
         if translations is None:
             translations = []
@@ -38,6 +42,7 @@ def __init__(self, inputs, schema, output_folder='_site', translations=None,
         self.indicator_downloads = indicator_downloads
         self.indicator_export_filename = indicator_export_filename
         self.ignore_na = ignore_out_of_scope_disaggregation_stats
+        self.cache_store = cache_store
 
 
     def build(self, language=None):
@@ -63,6 +68,15 @@ def build(self, language=None):
 
         for indicator_id in self.get_indicator_ids():
             indicator = self.get_indicator_by_id(indicator_id).language(language)
+            # Use the methodology to calculate a progress status.
+            progress_status = IndicatorProgress(
+                indicator,
+                logging=self.logging,
+                cache_store=self.cache_store,
+            ).get_indicator_status()
+            if progress_status:
+                # If the calculations returned something, set it in the indicator's 'meta' property.
+                indicator.meta['progress_status'] = progress_status
             # Output all the csvs
             status = status & write_csv(indicator_id, indicator.data, ftype='data', site_dir=site_dir)
             status = status & write_csv(indicator_id, indicator.edges, ftype='edges', site_dir=site_dir)

tests/assets/progress-calculation/data/indicator_1-1-1.csv

@@ -0,0 +1,7 @@
+Year,SEX,Value
+2020,,100
+2021,,120
+2020,M,50
+2021,M,60
+2020,F,70
+2021,F,80

tests/assets/progress-calculation/indicator-config/1-1-1.yml

@@ -0,0 +1,3 @@
+foo: bar
+page_content: Hello world
+auto_progress_calculation: true