Plotter.kde_distribution_attributes

Plotter.kde_distribution_attributes(block: str, attributes: List[str] | None = None, transformed: bool = False, per_column: bool = False, n_cols: int = 3, sub_figs: bool = False, cumulative: bool = False, output_name: str | None = None) → Figure | None[source]

Plots the probability density distribution or/and the cumulative density distribution of all the selected attributes (= DataObject’s) in the given data block using kernel density estimation.

Parameters:

  • block (str) – Name of the data block to be plotted. The block 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 are plotted.

  • transformed (bool, optional, default=False) – If True, the data is plotted transformed, while False returns the plots it in its original domain

  • per_column (bool, optional, default=False) – If True, each column (= dimension) of a DataObject is plotted as separate trace, otherwise all data is flattened to a single trace.

  • n_cols (int, optional, default=3) – Number of columns in the plot. Argument is ignored if sub_figs=True.

  • sub_figs (bool, optional, default=False) – If True, each trace is plotted in a separate figure.

  • cumulative (str, optional, default=False) – If True, the cumulative density distribution is plotted instead of the probability density distribution.e

  • output_name (str, optional, default=None) – Name of the output file. If None, the name is automatically generated from the block name.

Returns:

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