Skip to main content

summary

Get Summary Statistics.

The summary that offers a snapshot of its central tendencies, variability, and distribution. This command calculates essential statistics, including mean, standard deviation, variance, and specific percentiles, to provide a detailed profile of your target column. B y examining these metrics, you gain insights into the data's overall behavior, helping to identify patterns, outliers, or anomalies. The summary table is an invaluable tool for initial data exploration, ensuring you have a solid foundation for further analysis or reporting.

Parameters

data: list[openbb_core.provider.abstract.data.Data]

Time series data.

Optional: False


target: str

Target column name.

Optional: False


Returns

results: list[SummaryModel]

Serializable results.


provider: None

Provider name.


warnings: Optional[list[Warning_]]

list of warnings.


chart: Optional[Chart]

Chart object.


extra: dict[str, Any]

Extra info.


Data

count: int

mean: float

std: float

var: float

min: float

max: float

p_25: float

p_50: float

p_75: float