| Excerpt |
|---|
Extracts the ranked value from the values in a column, where k=1 returns the maximum value. The value for k must be between 1 and 1000, inclusive. Inputs can be Integer, Decimal, or Datetime. |
For purposes of this calculation, two instances of the same value are treated as separate values. So, if your dataset contains three rows with column values 10 , 9 , and 9 , then KTHLARGEST returns 9 for k=2 and k=3 .
When used in a pivot transform, the function is computed for each instance of the value specified in the group parameter. See Pivot Transform.
Input column can be of Integer, Decimal, or Datetime type. Other values column are ignored. If a row contains a missing or null value, it is not factored into the calculation.
| D lang syntax |
|---|
| RawWrangle | true |
|---|
| Type | ref |
|---|
| showNote | true |
|---|
| WrangleText | pivot value:kthlargest(myRating, 2) group:postal_code limit:1 |
|---|
|
kthlargest(myRating, 2) |
Output: Returns the second highest value from the myRating column.
| D lang syntax |
|---|
| RawWrangle | true |
|---|
| Type | syntax |
|---|
| showNote | true |
|---|
| WrangleText | pivot value:kthlargest(function_col_ref, k_integer) [ group:group_col_ref] [limit:limit_count] |
|---|
|
kthlargest(function_col_ref, k_integer) [ group:group_col_ref] [limit:limit_count] |
| Argument | Required? | Data Type | Description |
|---|
| function_col_ref | Y | string | Name of column to which to apply the function |
| k_integer | Y | integer (positive) | The ranking of the value to extract from the source column |
For more information on the group and limit parameters, see Pivot Transform.
function_col_ref
Name of the column the values of which you want to calculate the mean. Inputs must be Integer, Decimal, or Datetime values.
| Info |
|---|
NOTE: If the input is in Datetime type, the output is in unixtime format. You can wrap these outputs in the DATEFORMAT function to generate the results in the appropriate Datetime format. See DATEFORMAT Function. |
- Literal values are not supported as inputs.
- Multiple columns and wildcards are not supported.
| Required? | Data Type | Example Value |
|---|
| Yes | String (column reference) | myValues |
k_integer
Integer representing the ranking of the value to extract from the source column.
| Info |
|---|
NOTE: The value for k must be an integer between 1 and 1,000 inclusive. |
-
k=1 represents the maximum value in the column. - If k is greater than or equal to the number of values in the column, the minimum value is returned.
- Missing and null values are not factored into the ranking of
k.
| Required? | Data Type | Example Value |
|---|
| Yes | Integer (positive) | 4 |
| Include Page |
|---|
| EXAMPLE - KTHLARGEST Function |
|---|
| EXAMPLE - KTHLARGEST Function |
|---|
|
