Skip to content

Resolve "New functions to support Doppio project summary tabs"

Matthew Iadanza requested to merge 144-functions-for-summary-tabs into main

New 'summary_data' functions for metadata reports, reference lists, and archives on the lefthand panel of the home page. Skipping depositions for the moment because of the upcoming refactor.

Each type has methods to create reports, remove reports, and retrieve the reports data in pipeliner.manage_project.PipelinerProject as create_<type>, remove_<type>, and get_<type>_summary_data

get_<type>_summary_data returns ([column, headers], [[line1, data], ..., [lineN, data]])

The remove reports and get summary data methods are static. They could be spun off into separate functions so they don't need a PipelinerProject if that would be more efficient.

The reports are all stored in their own dirs ReferenceReports, MetadataReports, and ProjectArchives respectivly.

All info abot the reports is stored in a 4 block starfile called pipeliner_summary_data.star

Example:

data_metadata_reports
loop_
_pipelinerMetadataReportName
_pipelinerInitiatedFrom
_pipelinerNumberOfJobs
MetadataReports/20230322122525_job002.json MotionCorr/job002/ 1
MetadataReports/20230322123534_job003.json CtfFind/job003/ 2
MetadataReports/20230322124555_job004.json AutoPick/job004/ 1
MetadataReports/20230322125784_job005.json Extract/job005/ 4

data_reference_reports
loop_
_pipelinerReferenceReportName
_pipelinerInitiatedFrom
ReferenceReports/20230322122525_job002.json MotionCorr/job002/
ReferenceReports/20230322123534_job003.json CtfFind/job003/
ReferenceReports/20230322124555_job004.json AutoPick/job004/
ReferenceReports/20230322125784_job005.json Extract/job005/

data_deposition_files
loop_
_pipelinerDepositionFileName
_pipelinerInitiatedFrom
_pipelinerDepositionType
DepositionFiles/20230322122525_job002.json MotionCorr/job002/   empiar
DepositionFiles/20230322123534_job003.json CtfFind/job003/      pdb
DepositionFiles/20230322124555_job004.json AutoPick/job004/     emdb
DepositionFiles/20230322125784_job005.json Extract/job005/      pdb

data_project_archives
loop_
_pipelinerArchiveName
_pipelinerInitiatedFrom
_pipelinerArchiveType
DepositionFiles/20230322122525_job002.json MotionCorr/job002/   full
DepositionFiles/20230322123534_job003.json CtfFind/job003/      full
DepositionFiles/20230322124555_job004.json AutoPick/job004/     simple
DepositionFiles/20230322125784_job005.json Extract/job005/      full

Merge request reports