gemseo / post / dataset

Hide inherited members

boxplot module

Draw the boxplots of some variables from a Dataset.

A boxplot represents the median and the first and third quartiles of numerical data. The variability outside the inter quartile domain can be represented with lines, called whiskers. The numerical data that are significantly different are called outliers and can be plotted as individual points beyond the whiskers.

class gemseo.post.dataset.boxplot.Boxplot(dataset, *datasets, variables=(), center=False, scale=False, use_vertical_bars=True, add_confidence_interval=False, add_outliers=True, opacity_level=0.25, **boxplot_options)[source]

Bases: DatasetPlot

Draw the boxplots of some variables from a Dataset.

Parameters:

  • dataset (Dataset) – The dataset containing the data to plot.

  • *datasets (Dataset) – Datasets containing other series of data to plot.

  • variables (Iterable[str]) –

    The names of the variables to plot. If empty, use all the variables.

    By default it is set to ().

  • center (bool) –

    Whether to center the variables so that they have a zero mean.

    By default it is set to False.

  • scale (bool) –

    Whether to scale the variables so that they have a unit variance.

    By default it is set to False.

  • use_vertical_bars (bool) –

    Whether to use vertical bars.

    By default it is set to True.

  • add_confidence_interval (bool) –

    Whether to add the confidence interval (CI) around the median; a CI is also called notch.

    By default it is set to False.

  • add_outliers (bool) –

    Whether to add the outliers.

    By default it is set to True.

  • opacity_level (float) –

    The opacity level for the faces, between 0 and 1.

    By default it is set to 0.25.

  • **boxplot_options (Any) – The options of the wrapped boxplot function.

Raises:

ValueError – If the dataset is empty.

class PlotEngine(value)

Bases: StrEnum

An engine of plots.

MATPLOTLIB = 'MatplotlibPlotFactory'
PLOTLY = 'PlotlyPlotFactory'
execute(save=True, show=False, file_path='', directory_path='', file_name='', file_format='png', file_name_suffix='', **engine_parameters)

Execute the post-processing.

Parameters:

  • save (bool) –

    Whether to save the plot.

    By default it is set to True.

  • show (bool) –

    Whether to display the plot.

    By default it is set to False.

  • file_path (str | Path) –

    The path of the file to save the figures. If empty, create a file path from directory_path, file_name and file_format.

    By default it is set to “”.

  • directory_path (str | Path) –

    The path of the directory to save the figures. If empty, use the current working directory.

    By default it is set to “”.

  • file_name (str) –

    The name of the file to save the figures. If empty, use a default one generated by the post-processing.

    By default it is set to “”.

  • file_format (str) –

    A file format, e.g. ‘png’, ‘pdf’, ‘svg’, …

    By default it is set to “png”.

  • file_name_suffix (str) –

    The suffix to be added to the file name.

    By default it is set to “”.

  • **engine_parameters (Any) – The parameters specific to the plot engine.

Returns:

The figures.

Return type:

list[BasePlot]

DEFAULT_PLOT_ENGINE: ClassVar[PlotEngine] = 'MatplotlibPlotFactory'

The default engine of plots.

FILE_FORMATS_TO_PLOT_ENGINES: ClassVar[dict[str, PlotEngine]] = {'html': PlotEngine.PLOTLY}

The file formats bound to the engines of plots.

The method execute() uses this dictionary to select the engine of plots associated with its file_format argument. If missing, the method uses the DEFAULT_PLOT_ENGINE.

property color: str | list[str]

The color.

Either a global one or one per item if n_items is non-zero. If empty, use a default one.

property colormap: str

The color map.

property dataset: Dataset

The dataset.

property fig_size: FigSizeType

The figure size.

property fig_size_x: float

The x-component of figure size.

property fig_size_y: float

The y-component of figure size.

property figures: list[BasePlot]

The figures.

property font_size: int

The font size.

property grid: bool

Whether to add a grid.

property labels: Mapping[str, str]

The labels for the variables.

property legend_location: str

The location of the legend.

property linestyle: str | Sequence[str]

The line style.

Either a global one or one per item if n_items is non-zero. If empty, use a default one.

property marker: str | Sequence[str]

The marker.

Either a global one or one per item if n_items is non-zero. If empty, use a default one.

opacity_level: float

The opacity level for the faces, between 0 and 1.

property output_files: list[str]

The paths to the output files.

property rmax: float | None

The maximum value on the r-axis; if None, compute it from data.

property rmin: float | None

The minimum value on the r-axis; if None, compute it from data.

property title: str

The title of the plot.

property xlabel: str

The label for the x-axis.

property xmax: float | None

The maximum value on the x-axis; if None, compute it from data.

property xmin: float | None

The minimum value on the x-axis; if None, compute it from data.

property xtick_rotation: float

The rotation angle in degrees for the x-ticks.

property ylabel: str

The label for the y-axis.

property ymax: float | None

The maximum value on the y-axis; if None, compute it from data.

property ymin: float | None

The minimum value on the y-axis; if None, compute it from data.

property zlabel: str

The label for the z-axis.

property zmax: float | None

The maximum value on the z-axis; if None, compute it from data.

property zmin: float | None

The minimum value on the z-axis; if None, compute it from data.

Examples using Boxplot

Boxplot

Boxplot