metawards.analysis.save_summary_plots

metawards.analysis.save_summary_plots(results: str, output_dir: Optional[str] = None, format: str = 'jpg', dpi: int = 150, align_axes: bool = True, verbose=False)[source]

Create summary plots of the data contained in the passed ‘results.csv.bz2’ file that was produced by metawards and save them to disk.

Parameters

  • results (str) – The full path to the file containing the results. This must have been created by metawards

  • output_dir (str) – Path to the directory in which you want to place the graphs. This defaults to the same directory that contains ‘results’

  • format (str) – The format to use to save the graphs. This defaults to ‘pdf’

  • dpi (int) – The dots-per-inch to use when saving bitmap graphics (e.g. png, jpg etc)

  • align_axes (bool) – Whether or not to plot all graphs in a set on the same axes

  • verbose (bool) – Whether or not to print progress to the screen

Returns

filenames – Full file paths of all of the files written by this function

Return type

List(str)