utils.stats.calculate_outliers

utils.stats.calculate_outliers(series_or_df, irqmultiplier=1.5)

Calculate the number of outliers using the IQR method.

Accepts either a pandas Series or a pandas DataFrame. For a DataFrame, counts outliers across all numeric columns and returns the total count.

Parameters

Name Type Description Default
series_or_df Union[pd.Series, pd.DataFrame] pd.Series or pd.DataFrame containing numeric data. required
irqmultiplier float Multiplier for IQR to define fences. Defaults to 1.5. 1.5

Returns

Name Type Description
int int The number of outliers.

Examples

>>> import pandas as pd
>>> from spotoptim.utils.stats import calculate_outliers
>>> s = pd.Series([1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 100])
>>> calculate_outliers(s)
1
>>> df = pd.DataFrame({
...     'a': [1, 2, 3, 100],
...     'b': [10, 12, 11, 10]
... })
>>> calculate_outliers(df)
1