describe builtin

describe(
    values, *, weights=None, quantiles=Ellipsis, data=None
)

Weighted (declustered) statistics of values; NaN is skipped.

Parameters:

Name	Type	Description	Default
values	array_like or str	Values, or their column in data.	required
weights	array_like or str	Declustering weights; default the volumes of a BlockModel data, else 1.	None
quantiles	sequence of float	Probabilities of the quantile keys.	Ellipsis
data	(PointSet, BlockModel, Table or dict)	Where column names are looked up.	None

Returns:

Type	Description
dict	n, mean, variance, std, cv, min, max and one key per quantile named P10, P97.5, ... (mid-point cumulative weights).

used in

• Samples and support
• Describing data
• Simulation
• Compare two estimates of one deposit
• quick tour
• spatial bootstrap
• normal-score transform
• direct sequential simulation