synpop.survey_report

Survey QA report generation helpers.

synpop.survey_report.build_survey_report_visuals(all_responses_df, good_responses_df)

Build the ordered visual list expected by the survey QA HTML report.

Parameters:

Name	Type	Description	Default
all_responses_df	Any	Spark DataFrame containing all responses before QA.	required
good_responses_df	Any	Spark DataFrame containing responses that passed QA.	required

Returns:

Type	Description
List[str]	Inline SVG strings ordered for build_survey_report_html. Returns
List[str]	an empty list if visual generation fails.

synpop.survey_report.build_survey_report_html(logs_df, country_code, good_records, dumped_records, svg_list, all_responses_df=None)

Build a standalone survey QA HTML report.

Parameters:

Name	Type	Description	Default
logs_df	Any	Spark DataFrame containing one row per failed QA check.	required
country_code	str	Country code displayed in the report.	required
good_records	int	Number of responses retained after QA.	required
dumped_records	int	Number of responses rejected by QA.	required
svg_list	list	Ordered SVG or HTML visualization fragments.	required
all_responses_df	Any	Optional unfiltered responses used for report details.	None

Returns:

Type	Description
str	Complete HTML report document.