sage icon indicating copy to clipboard operation
sage copied to clipboard

Feature/html results/QC report

Open singjc opened this issue 9 months ago • 1 comments

This PR adds the option to generate an interactive html report that summarizes the results from Sage, and plots some QC plots for inspecting the scoring and correlation of predicted RT/IM. This also addresses #168, although the stats summary table is downloadable within the html report. Should it also be directly written out to a tsv file?

New feature: HTML report generation

  • crates/sage-cli/Cargo.toml: Added maud and report-builder dependencies to support HTML report generation.

Struct updates

  • crates/sage-cli/src/input.rs: Updated the Search and Input structs to include a new write_report field.
  • crates/sage-cli/src/runner.rs: Added write_report method to Runner to generate and save the html report

Command-line interface updates

  • crates/sage-cli/src/input.rs: Modified the impl Input block to handle the new write-report option.
  • crates/sage-cli/src/main.rs: Added a new command-line argument --write-report to enable HTML report generation.

singjc avatar Mar 16 '25 18:03 singjc

This looks awesome! I will do a review in the next week or two.

lazear avatar Mar 19 '25 18:03 lazear

Sorry this took so long - I think the downloadable CSV is sufficient! I have cleared up the merge conflicts and will be merging this momentarily

lazear avatar May 06 '25 17:05 lazear