Generate a summary of the dataset based on specified configurations.

This method provides a comprehensive summary for a dataset, allowing customization of grouped statistics, histogram generation, and deeper dataset analysis by unnesting nested structures.

Parameters:¶

config: list[tuple] | None = None¶

A list of tuples defining the configuration for the summary statistics. Each tuple typically represents a specific computation or analysis to perform on the dataset.

by: str | list[str] | None = None¶

Defines the columns by which to group data before generating the summary. If multiple strings are provided, data is grouped hierarchically by the specified columns.

hist: bool = False¶

If True, includes histograms for numeric fields in the summary output. Useful for visualizing the distribution of numeric data.

unnest_structs: bool | ColumnNameOrSelector = False¶

If True, unnests any nested structures in the dataset to enable deeper analysis. A ColumnNameOrSelector can also be provided to target specific fields to unnest.