Skip to content

Update user-guide.rst #285

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 11, 2023
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion docs/user-guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -259,7 +259,13 @@ If `interpolate` is not chained after a `resample` operation, the method automat
dataset into a given frequency, then performs interpolation on the sampled time-series dataset.

Possible values for frequency include patterns such as 1 minute, 4 hours, 2 days or simply sec, min, day.
For the accepted functions to aggregate data, options are 'floor', 'ceil', 'min', 'max', 'mean'.
For the accepted functions to aggregate data, options are 'floor', 'ceil', 'min', 'max', 'mean'. Descriptions of each of these are indicated below:

* `floor` - In the time bucket (based on frequency), choose the earliest value by timestamp.
* `ceil` - In the time bucket, choose the latest value by timestamp.
* `min` - In the time bucket, choose the minimum (lowest) value regardless of any timestamp.
* `max` - In the time bucket, choose the maximum (highest) value regardless of any timestamp.
* `mean` - In the time bucket, choose the average value regardless of any timestamp.

`NULL` values after re-sampling are treated the same as missing values. Ability to specify `NULL` as a valid value is
currently not supported.
Expand Down