Skip to content
Snippets Groups Projects

docstring changes

Merged David Schäfer requested to merge docs into develop
Files
3
+ 4
4
@@ -581,13 +581,13 @@ class OutliersMixin:
**kwargs,
) -> "SaQC":
"""
Flag outiers using the modified Z-score outlier detection.
Flag outiers using the modified Z-score outlier detection method.
See references [1] for more details on the algorithm.
Note
----
Date needs to be sampled at a regular equidistant time grid.
Data needs to be sampled at a regular equidistant time grid.
Parameters
----------
@@ -892,13 +892,13 @@ class OutliersMixin:
window : {int, str}
Size of the testing window.
If an integer, the fixed number of observations used for each window.
I an offset string the time period of each window.
If an offset string the time period of each window.
alpha : float, default 0.05
Level of significance, the grubbs test is to be performed at. Must be between 0 and 1
min_periods : int, default 8
Mminimum number of values needed in a ``window`` in order to perform the grubs test.
Minimum number of values needed in a ``window`` in order to perform the grubs test.
Ignored if ``window`` is an integer.
pedantic: boolean, default False
Loading