stangene.report

Reporting: summaries, conflict detection, markdown reports, and output writing.

Reporting: summaries, conflict detection, and output writing.

stangene.report.summary(result)[source]
Return type:

dict

stangene.report.conflict_report(result)[source]
Return type:

DataFrame

stangene.report.generate_markdown_report(result, title='Gene Harmonization Report', max_unmapped_rows=50, max_conflict_rows=50, max_outdated_rows=50, max_ambiguous_rows=50, output_path=None)[source]

Generate a comprehensive markdown report of harmonization results.

Parameters:

  • result – HarmonizationResult from harmonize().

  • title (str) – Report title.

  • max_unmapped_rows (int) – Max unmapped features to list individually.

  • max_conflict_rows (int) – Max many-to-one collision groups to list.

  • max_outdated_rows (int) – Max outdated name rows to list.

  • max_ambiguous_rows (int) – Max ambiguous features to list.

  • output_path (str) – If provided, write the report to this file.

Return type:

str

Returns:

The markdown report as a string.

stangene.report.write_reports(result, output_dir, merge_result=None)[source]
Return type:

None