From de9f81740377b27e4e7313bd52848be9a353d020 Mon Sep 17 00:00:00 2001
From: tm689 <tm689@cam.ac.uk>
Date: Wed, 16 Aug 2023 16:12:01 +0100
Subject: [PATCH] doc: description for grouping
---
coordinator/ProcessorSurveys.py | 17 ++++++++++++++++-
1 file changed, 16 insertions(+), 1 deletion(-)
diff --git a/coordinator/ProcessorSurveys.py b/coordinator/ProcessorSurveys.py
index 5b874ba..1c05c99 100644
--- a/coordinator/ProcessorSurveys.py
+++ b/coordinator/ProcessorSurveys.py
@@ -1,5 +1,20 @@
#ProcessorSurveys.py
-'''Functions to process the survey component.'''
+'''Functions to process the survey component.
+
+Group surveys and run source gen on each groups:
+Grouping is only run if it is defined in the config (otherwise it use all available surveys).
+Example:
+ "Groups" : {
+ "PROD" : ["ODK-server", "kobo-server", "CSV-CAM"],
+ "WRT" : ["ODK", "CSV"]
+ }
+
+It is based on the 'Origin' column of the surveys.
+All unique 'Origin' will create its own group alongside the ones defined in the config.
+Groups can be ignored by defining 'GroupsToIgnore' in the config (this has no effect on 'Origin' types).
+Example:
+ "GroupsToIgnore" : ["ODK-server", "kobo-server", "CSV-CAM", "ODK", "CSV", "PV"]
+'''
import csv
import datetime
--
GitLab