plot_correlation_map

pyoptex.doe.utils.evaluate.plot_correlation_map(Y, factors, Y2X, model=None, method='pearson', drop_nans=True, corr_abs=False)[source]

Plots the map of correlations for the provided design.

Parameters

Ypd.DataFrame

The decoded and denormalized design.

factorslist(Factor)

The list of factors in the design.

Y2Xfunc(Y)

The function to convert the design matrix Y to a model matrix X.

modelpd.DataFrame or None

The model, used to extract the parameter names.

method‘pearson’, ‘kendall’, or ‘spearman’

The correlation method to use.

drop_nansbool

Whether to drop rows and columns that are completely nan.

corr_absbool

Whether to drop the sign of the correlation. If True, the colors in the figure only display magnitudes using a sequential colormap (‘Cividis’). If False, the colors of the figure show the sign, using a diverging colormap (‘RdBu’).

Returns

figplotly.graph_objects.Figure

The figure of the map of correlations.