From 2bd0dc2cd4604ac56c9717e268a76b576423fffb Mon Sep 17 00:00:00 2001 From: rportilla-databricks <38080604+rportilla-databricks@users.noreply.github.com> Date: Thu, 29 Dec 2022 10:14:10 -0500 Subject: [PATCH 1/2] Update user-guide.rst --- docs/user-guide.rst | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/user-guide.rst b/docs/user-guide.rst index 3bfad1c7..8b7d9cb2 100644 --- a/docs/user-guide.rst +++ b/docs/user-guide.rst @@ -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. From 4c4260d64d764f4c2b5b7899c0b60e45a150b7b4 Mon Sep 17 00:00:00 2001 From: rportilla-databricks <38080604+rportilla-databricks@users.noreply.github.com> Date: Thu, 29 Dec 2022 12:09:38 -0500 Subject: [PATCH 2/2] Update docs/user-guide.rst Co-authored-by: Lorin Dawson <22798188+R7L208@users.noreply.github.com> --- docs/user-guide.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/user-guide.rst b/docs/user-guide.rst index 8b7d9cb2..4f4dca15 100644 --- a/docs/user-guide.rst +++ b/docs/user-guide.rst @@ -259,13 +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'. Descriptions of each of these are indicated below: +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: -* `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. +* `floor` - returns the earliest value by timestamp. +* `ceil` - returns the latest value by timestamp. +* `min` - returns the lowest value regardless of any timestamp. +* `max` - returns the highest value regardless of any timestamp. +* `mean` - returns 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.