emodpy_hiv.plotting.plot_inset_chart_mean_compare module#

emodpy_hiv.plotting.plot_inset_chart_mean_compare.calculate_mean(dir_name: str)[source]#

Calculate the mean of the InsetChart.json files in the given directory.

Parameters:

dir_name – Directory with InsetChart.json files

Returns:

Mean ChannelReport object raw_data_list: List of raw data dictionaries from the InsetChart.json files

Return type:

mean_cr

emodpy_hiv.plotting.plot_inset_chart_mean_compare.plot_mean(dir1: str, dir2: str, dir3: str, title: str | None = None, show_raw_data: bool = False, subplot_index_min: int = 0, subplot_index_max: int = 100, output: str | None = None)[source]#

Plot the mean of the InsetChart.json files in the given directories.

Parameters:

  • dir1 – Directory with InsetChart.json files

  • dir2 – Directory with InsetChart.json files

  • dir3 – Directory with InsetChart.json files

  • title – Title of Plot

  • show_raw_data – If true, shows the raw/individual simulation data in a lighter color.

  • subplot_index_min – The index of the first subplot to show based on the alphabetical order of the channels in the report.

  • subplot_index_min – The index of the last subplot to show based on the alphabetical order of the channels in the report.

  • output – If provided, a directory will be created and images saved to the folder. If not provided, it opens windows.

Returns:

None, if output is provided, an image will be saved to the output directory, else a window will be opened.