Plotter.correlation

Plotter.correlation(block: str | List[str], attributes: List[str] | None = None, output_name: str | None = None, color_range: str = 'unit') → Figure | None[source]

Plots the correlation between all the selected attributes (= DataObject’s) in the given data blocks. Only numeric attributes are considered.

Parameters:

block (Union[str, List[str]]) – Name or list of names of the data blocks to be plotted. The blocks must be available in the dataset or in the datamodule.
attributes (List[str], optional, default=None) – List of attributes (= names of DataObject’s) to be plotted. If None, all attributes of the blocks are plotted.
output_name (str, optional, default=None) – Name of the output file. If None, the name is automatically generated from the data block names.
color_range (str, optional, default=’unit’) – The range of the color scale. Possible values are ‘unit’, ‘auto’, ‘symmetric’. If ‘unit’, the color scale is fixed to [-1, 1]. If ‘auto’, the color scale is automatically adjusted to the data [min, max]. If ‘symmetric’, the color scale is fixed to the maximum absolute value a of the data [-a, a].

Returns:

Optional[plotly.graph_objects.Figure] – Plotly figure object, if self.output is None, otherwise None.