fiesta.plotter.plot_boxplot#

fiesta.plotter.plot_boxplot(arrays, write_mean=True, write_median=True, write_minmax=True, write_total=True, colors=None, linestyles=None, linewidths=None, labels=None, save=None, **kwargs)[source]#

A general function to generate boxplot (or box and whiskers plot) of data.

Parameters:

  • arrays (list of list’s) – The list of data arrays to generate boxplot of.

  • write_mean (bool) – If True (default), the mean value is mentioned below each mean line.

  • write_median (bool) – If True (default), the median value is mentioned below each median line.

  • write_minmax (bool) – If True (default), the minimum and maximum values are mentioned below the end whiskers.

  • write_total (bool) – If True (default), the length of data arrays is mentioned at the right side of the plot, outside the axes.

  • colors (list, optional) – A list of matplotlib-compatible color strings corresponding to each line plotted. If None (default), colors are picked by cycling through matplotlib tab10 colour palette.

  • linestyles (list, optional) – A list of matplotlib-compatible linestyle strings corresponding to each line plotted. If None (default), they are set to -.

  • linewidths (list, optional) – A list of linewidths corresponding to each line plotted. If None (default), they are set to 1.5.

  • labels (list, optional) – A list of labels corresponding to each box plotted. If None (default), they are numbered 1, ..., n.

  • save (str, optional) – The name of the file to save the plot as. If None (default), plot is not saved.

  • **kwargs (dict, optional) – Additional matplotlib-based keyword arguments to control finer details of the plot.

Returns:

fig (Figure) – Main Figure instance.