## Key

• This line was removed.
• Formatting was changed.

D toc

Excerpt

Extracts the ranked value from the values in a column, where `k=1` returns the maximum value, when a specified condition is met. The value for `k` must be between 1 and 1000, inclusive. Inputs can be Integer, Decimal, or Datetime.

`KTHLARGESTIF` calculations are filtered by a conditional applied to the group.

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`.

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.

Info

NOTE: When added to a transformation, this function is applied to the current sample. If you change your sample or run the job, the computed values for this function are updated. Transformations that change the number of rows in subsequent recipe steps do not affect the values computed for this step.

To perform a simple kth largest calculation without conditionals, use the `KTHLARGEST` function. See KTHLARGEST Function.

D s lang vs sql

D s
snippet Basic

D lang syntax
RawWrangle true ref true pivot value: kthlargestif(POS_Sales, 1, DayOfWeek == 'Saturday') group:storeNbr limit:1

kthlargestif(POS_Sales, 1, DayOfWeek == 'Saturday')

Output: Returns the top value (rank=1) from the `POS_Sales` column when the `DayOfWeek` value is `Saturday`.

D s
snippet Syntax

D lang syntax
RawWrangle true syntax true pivot value:kthlargestif(col_ref, limit, test_expression) [group:group_col_ref] [limit:limit_count]

kthlargestif(col_ref, limit, test_expression) [group:group_col_ref] [limit:limit_count]

ArgumentRequired?Data TypeDescription
col_refYstringReference to the column you wish to evaluate.
k_integerYintegerThe ranking of the value to extract from the source column
test_expressionYstringExpression that is evaluated. Must resolve to `true` or `false`

D s lang notes

For more information on the `group` and `limit` parameter, see Pivot Transform.

### col_ref

Name of the column whose values you wish to use in the calculation. 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 output the results in the appropriate Datetime format. See DATEFORMAT Function.

D s
snippet usage

Required?Data TypeExample Value
YesString that corresponds to the name of the column`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`.

### test_expression

This parameter contains the expression to evaluate. This expression must resolve to a Boolean (`true` or `false`) value.

D s
snippet usage

Required?Data TypeExample Value
YesString expression that evaluates to `true` or `false``(LastName == 'Mouse' && FirstName == 'Mickey') `

D s
snippet Examples

### Example - Second-most measurements for a specific city

Include Page
 EXAMPLE - KTHLARGESTIF Function EXAMPLE - KTHLARGESTIF Function

D s also
label aggregate