Skip to content

Commit b64eb11

Browse files
Update user-guide.rst (#285)
* Update user-guide.rst * Update docs/user-guide.rst Co-authored-by: Lorin Dawson <[email protected]> Co-authored-by: Lorin Dawson <[email protected]>
1 parent 99bcdf4 commit b64eb11

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

docs/user-guide.rst

+7-1
Original file line numberDiff line numberDiff line change
@@ -259,7 +259,13 @@ If `interpolate` is not chained after a `resample` operation, the method automat
259259
dataset into a given frequency, then performs interpolation on the sampled time-series dataset.
260260

261261
Possible values for frequency include patterns such as 1 minute, 4 hours, 2 days or simply sec, min, day.
262-
For the accepted functions to aggregate data, options are 'floor', 'ceil', 'min', 'max', 'mean'.
262+
For the accepted functions to aggregate data within time buckets, options are ’floor’, ’ceil’, ’min’, ’max’, ’mean’. Descriptions of each of these are indicated below:
263+
264+
* `floor` - returns the earliest value by timestamp.
265+
* `ceil` - returns the latest value by timestamp.
266+
* `min` - returns the lowest value regardless of any timestamp.
267+
* `max` - returns the highest value regardless of any timestamp.
268+
* `mean` - returns the average value regardless of any timestamp.
263269

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

0 commit comments

Comments
 (0)