Skip to main content

visualization.report

logger_config​

logger​

generate_reports​

@save_state(model=GenerateReportsFunctionSchema)
def generate_reports(config: dict, save_logs: bool = True) -> None

Generate reports and UMAP for all sessions in the project.

Parameters

  • config (dict): Configuration parameters.
  • save_logs (bool, optional): Whether to save logs. Defaults to True.

Returns

  • None

report​

def report(config: dict,
           segmentation_algorithm: str = "hmm",
           save_to_file: bool = True,
           show_figure: bool = True,
           save_logs: bool = True) -> None

Report for a project.

Parameters

  • config (dict): Configuration parameters.
  • segmentation_algorithm (str, optional): Segmentation algorithm to use. Defaults to "hmm".
  • save_to_file (bool, optional): Whether to save the report to file. Defaults to True.
  • show_figure (bool, optional): Whether to show the figure. Defaults to True.
  • save_logs (bool, optional): Whether to save logs. Defaults to True.

Returns

  • None

plot_community_motifs​

def plot_community_motifs(motif_labels,
                          community_labels,
                          community_bag,
                          title: str = "Community and Motif Counts",
                          save_to_file: bool = False,
                          save_path: str = "")

Generates a bar plot to represent community and motif counts with percentages.