gemseo / post / dataset

Show 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=None, center=False, scale=False, use_vertical_bars=True, add_confidence_interval=False, add_outliers=True, **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 (Sequence[str] | None) – The names of the variables to plot. If None, use all the variables.

  • 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.

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

Raises:

ValueError – If the dataset is empty.

color: str | list[str]

The color(s) for the series.

If empty, use a default one.

colormap: str

The color map.

dataset: Dataset

The dataset to be plotted.

fig_size: FigSizeType

The figure size.

font_size: int

The font size.

legend_location: str

The location of the legend.

linestyle: str | list[str]

The line style(s) for the series.

If empty, use a default one.

marker: str | list[str]

The marker(s) for the series.

If empty, use a default one.

opacity_level: ClassVar[float] = 0.25

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

title: str

The title of the plot.

xlabel: str

The label for the x-axis.

xmax: float | None

The maximum value on the x-axis.”.

If None, compute it from data.

xmin: float | None

The minimum value on the x-axis.

If None, compute it from data.

xtick_rotation: float

The rotation angle in degrees for the x-ticks.

ylabel: str

The label for the y-axis.

ymax: float | None

The maximum value on the y-axis.

If None, compute it from data.

ymin: float | None

The minimum value on the y-axis.

If None, compute it from data.

zlabel: str

The label for the z-axis.

zmax: float | None

The maximum value on the z-axis.

If None, compute it from data.

zmin: float | None

The minimum value on the z-axis.

If None, compute it from data.

Examples using Boxplot

Boxplot

Boxplot