minor updates to aggreate function docs
parent
a680327f2c
commit
0eccc61f4e
|
@ -695,6 +695,14 @@
|
|||
font-size: .8rem;
|
||||
}
|
||||
}
|
||||
|
||||
//////////////////////////////// Miscellaneous ///////////////////////////////
|
||||
|
||||
.required {
|
||||
color:#FF8564;
|
||||
font-weight:700;
|
||||
font-style: italic;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
|
|
@ -22,14 +22,10 @@ covariance(columns: ["column_x", "column_y"], pearsonr: false, valueDst: "_value
|
|||
## Parameters
|
||||
|
||||
### columns
|
||||
A list of columns on which to operate.
|
||||
A list of **two columns** on which to operate. <span class="required">Required</span>
|
||||
|
||||
_**Data type:** Array of strings_
|
||||
|
||||
{{% note %}}
|
||||
Exactly two columns must be provided to the `columns` property.
|
||||
{{% /note %}}
|
||||
|
||||
### pearsonr
|
||||
Indicates whether the result should be normalized to be the Pearson R coefficient.
|
||||
|
||||
|
|
|
@ -41,7 +41,7 @@ When set to `true`, if a value is less than the previous value, it is assumed th
|
|||
_**Data type:** Boolean_
|
||||
|
||||
### column
|
||||
The column on which to compute the derivative.
|
||||
The column to use to compute the derivative.
|
||||
Defaults to `"_value"`.
|
||||
|
||||
_**Data type:** String_
|
||||
|
|
|
@ -29,7 +29,7 @@ When set to `true`, if a value is less than the previous value, it is assumed th
|
|||
_**Data type:** Boolean_
|
||||
|
||||
### column
|
||||
The column on which to compute the difference.
|
||||
The column to use to compute the difference.
|
||||
Defaults to `"_value"`.
|
||||
|
||||
_**Data type:** String_
|
||||
|
|
|
@ -22,7 +22,7 @@ mean(column: "_value")
|
|||
## Parameters
|
||||
|
||||
### column
|
||||
The column on which to compute the mean.
|
||||
The column to use to compute the mean.
|
||||
Defaults to `"_value"`.
|
||||
|
||||
_**Data type:** String_
|
||||
|
|
|
@ -36,7 +36,7 @@ value that represents the specified quantile.
|
|||
## Parameters
|
||||
|
||||
### column
|
||||
The column on which to compute the quantile.
|
||||
The column to use to compute the quantile.
|
||||
Defaults to `"_value"`.
|
||||
|
||||
_**Data type:** String_
|
||||
|
|
|
@ -21,15 +21,15 @@ _**Function type:** Aggregate_
|
|||
_**Output data type:** Integer or Float (inherited from input column type)_
|
||||
|
||||
```js
|
||||
spread(columns: ["_value"])
|
||||
spread(column: "_value")
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
### columns
|
||||
Specifies a list of columns on which to operate. Defaults to `["_value"]`.
|
||||
### column
|
||||
The column on which to operate. Defaults to `"_value"`.
|
||||
|
||||
_**Data type:** Array of strings_
|
||||
_**Data type:** String_
|
||||
|
||||
## Examples
|
||||
```js
|
||||
|
|
|
@ -46,7 +46,7 @@ The resulting group keys for all tables will be: `[_time, _field_d1, _field_d2]`
|
|||
## Parameters
|
||||
|
||||
### tables
|
||||
The map of streams to be joined. <span style="color:#FF8564; font-weight:700;">Required</span>.
|
||||
The map of streams to be joined. <span class="required">Required</span>
|
||||
|
||||
_**Data type:** Object_
|
||||
|
||||
|
@ -55,7 +55,7 @@ _**Data type:** Object_
|
|||
{{% /note %}}
|
||||
|
||||
### on
|
||||
The list of columns on which to join. <span style="color:#FF8564; font-weight:700;">Required</span>.
|
||||
The list of columns on which to join. <span class="required">Required</span>
|
||||
|
||||
_**Data type:** Array of strings_
|
||||
|
||||
|
|
Loading…
Reference in New Issue