arviz_plots.backend.create_plotting_grid

arviz_plots.backend.create_plotting_grid#

arviz_plots.backend.create_plotting_grid(number, rows=1, cols=1, figsize=None, figsize_units='inches', squeeze=True, sharex=False, sharey=False, polar=False, width_ratios=None, plot_hspace=None, subplot_kws=None, **kwargs)[source]#

Create a chart with a grid of plots in it.

Parameters:
numberint

Number of plots required

rows, colsint, default 1

Number of rows and columns.

figsize(float, float), optional

Size of the figure in figsize_units.

figsize_units{“inches”, “dots”}, default “inches”

Units in which figsize is given.

squeezebool, default True

Delete dimensions of size 1 in the resulting array of plots

sharex, shareybool, default False

Flags that indicate the axis limits between the different plots should be shared.

polarbool, default False
width_ratiosarray_like of shape (cols,), optional
plot_hspacefloat, optional
subplot_kws, **kwargsmapping, optional

Arguments passed downstream to the plotting backend.

Returns:
chartchart type

The plotting backend object that represents the created chart

plotsplot type or ndarray of plot type

An array of the plotting backend objects that represent the plots. The returned object will be an array unless generating a 1x1 grid with squeeze set to True.