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. The value for k must be between 1 and 1000, inclusive. 

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

D s
snippetBasic

D code

pivot value:KTHLARGEST(myRating, 2) group:postal_code limit:1

Output: Generates a two-column table containing the unique values in the postal_code column and the second highest value from the myRating column for that postal_code value. The limit parameter defines the maximum number of output columns.

D s
snippetSyntax

D code

pivot value:KTHLARGEST(function_col_ref, k_integer) [group:group_col_ref] [limit:limit_count]

ArgumentRequired?Data TypeDescription
function_col_refYstringName of column to which to apply the function
k_integerYinteger (positive)The ranking of the value to extract from the source column

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

D s lang notes

function_col_ref

Name of the column the values of which you want to calculate the mean. Column must contain Integer or Decimal values.

  • Literal values are not supported as inputs. 
  • Multiple columns and wildcards are not supported.

D s
snippetusage

Required?Data TypeExample Value
YesString (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.

D s
snippetusage

Required?Data TypeExample Value
YesInteger (positive)4


D s
snippetExamples

Include Page
EXAMPLE - KTHLARGEST Function
EXAMPLE - KTHLARGEST Function

D s also
labelaggregate