panorama.info package#

Submodules#

panorama.info.info module#

Panorama Info Module - Pangenome Information Extraction and Visualization

This module provides functionality to extract, process, and export information from pangenome HDF5 files, generating interactive HTML reports for analysis.

panorama.info.info.check_info_args(args)#

Checks the validity of arguments for the info command.

Parameters:: args (Namespace) – Parsed command-line arguments

panorama.info.info.export_info(info_dict, output)#

Export extracted information to HTML files.

Parameters:

info_dict (Dict[str, Dict[str, Any]]) – Dictionary containing extracted pangenome information.
output (Path) – Output directory path where HTML files will be saved.

Raises:

NotImplementedError – If parameter or metadata export is requested (not yet implemented).
KeyError – If an unrecognized information type is provided.

Return type:

None

Note

Currently supports exporting status and content information. Parameter and metadata export functionality is planned for future implementation.

panorama.info.info.launch(args)#

Main command launcher for the info extraction functionality.

Parameters:: args (Namespace) – Parsed command-line arguments containing all user options.
Return type:: None

Note

This function orchestrates the entire workflow: validates input files, extracts information, and exports results to HTML files.

panorama.info.info.parser_info(parser)#

Configure an argument parser with info command-specific options.

Parameters:: parser (ArgumentParser) – Argument parser to configure.
Return type:: None

Note

Sets up required arguments (input files, output directory) and optional arguments for controlling which information types to extract and export.

panorama.info.info.subparser(sub_parser)#

Create the subparser for the info command.

Parameters:: sub_parser (_SubParsersAction) – Parent subparser to add the info command to.
Returns:: argparse.ArgumentParser – Configured argument parser for the info command.
Return type:: ArgumentParser

`PangenomeInfoExtractor`	A class to extract and process information from pangenome HDF5 files.
`HTMLExporter`	A class to export pangenome information as interactive HTML reports.