Documentation for the casman.visualization package.
Visualization package for CAsMan.
This package provides basic visualization capabilities including:
The package focuses on core functionality for assembly visualization.
Core visualization functions for CAsMan.
This module contains the legacy visualization functions that were previously in the main visualization.py module.
Functions:
format_ascii_chains() - Format assembly chains as ASCII textget_duplicate_connections() - Get information about duplicate connections in the databaseget_visualization_data() - Get data formatted for web visualizationget_chain_summary() - Get summary statistics about assembly chainsformat_chain_summary() - Format chain summary statistics as textprint_visualization_summary() - Print a summary of the visualization datamain() - Main function for command-line usageThis package provides basic visualization capabilities including:
The package focuses on core functionality for assembly visualization.
Signature: main() -> None
Main entry point for visualization package.
This module contains the legacy visualization functions that were previously in the main visualization.py module.
Signature: format_ascii_chains(db_dir: Optional[str]) -> str
Format assembly chains as ASCII text.
Parameters:
db_dir : str, optional Custom database directory. If not provided, uses the project root’s database directory.
Returns:
str Formatted ASCII representation of assembly chains.
Signature: get_duplicate_connections(db_dir: Optional[str]) -> Dict[str, List[Tuple[str, str, str]]]
Get information about duplicate connections in the database.
Returns:
Dict[str, List[Tuple[str, str, str]]] Dictionary mapping part numbers to list of (connected_to, scan_time, connected_scan_time) tuples for parts that appear multiple times in the database.
Signature: get_visualization_data(db_dir: Optional[str]) -> Dict[str, List[Dict[str, str]]]
Get data formatted for web visualization.
Parameters:
db_dir : str, optional Custom database directory. If not provided, uses the project root’s database directory.
Returns:
Dict[str, List[Dict[str, str]]] Dictionary containing nodes and links for visualization.
Signature: get_chain_summary(db_dir: Optional[str]) -> Dict[str, float]
Get summary statistics about assembly chains.
Parameters:
db_dir : str, optional Custom database directory. If not provided, uses the project root’s database directory.
Returns:
Dict[str, float] Dictionary containing chain statistics.
Signature: format_chain_summary() -> str
Format chain summary statistics as text.
Returns:
str Formatted summary statistics
Signature: print_visualization_summary() -> None
Print a summary of the visualization data.
Signature: main() -> None
Main function for command-line usage.