Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin

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. 

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 109, and 9, then KTHLARGEST returns 9 for k=2 and k=3.

Input column can be of Integer or Decimal type. Non-numeric data in the column is ignored. If a row contains a missing or null value, it is not factored into the calculation.

Info

NOTE: When added to a transform, 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. Transforms 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
snippetBasic

D code

pivot value: KTHLARGESTIF(POS_Sales, 1, DayOfWeek == 'Saturday') group:storeNbr limit:1

Output: Generates a two-column table containing the unique values for storeNbr and the top value (rank=1) from the POS_Sales column for each storeNbr when the DayOfWeek value is Saturday. The limit parameter defines the maximum number of output columns.

D s
snippetSyntax

D code

pivot value:LISTIF(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. Column must be a numeric (Integer or Decimal) type.

D s
snippetusage

Required?Data TypeExample Value
YesString that corresponds to the name of the columnmyValues

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
snippetusage

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


D s
snippetExamples

Example - Second-most measurements for a specific city

Include Page
EXAMPLE - KTHLARGESTIF Function
EXAMPLE - KTHLARGESTIF Function

D s also
labelaggregate