Skip to content
Snippets Groups Projects
Commit edf9622b authored by Peter Lünenschloß's avatar Peter Lünenschloß
Browse files

fixed/clarified docstring

parent 954ebf2d
No related branches found
No related tags found
2 merge requests!867Flag constants fix,!804Flag constants fix
......@@ -51,18 +51,18 @@ class ConstantsMixin:
thresh :
Maximum total change allowed per window.
window :
Size of the moving window. This determines the number of observations used
for calculating the absolute change per window.
Each window will be of either of a fixed number of periods (integer defined window),
or will have a fixed temporal extension (offset defined window).
min_periods :
Minimum number of observations in window required to generate
a flag. Must be an integer greater or equal `2`, because a
a flag. This is to exclude underpopulated offset defined windows from flagging.
Must be an integer greater or equal `2`, because a
single value would always be considered constant.
Defaults to `2`.
window :
Size of the moving window. This is the number of observations used
for calculating the statistic. Each window will be a fixed size.
If it is an offset then this will be the time period of each window.
Each window will be a variable sized based on the observations included
in the time-period.
"""
d: pd.Series = self._data[field]
validateWindow(window, index=d.index)
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment