Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space DEV and version r0811

D toc

Excerpt

Extracts the ranked unique 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 the same value of k. So, if your dataset contains four rows with column values 10 , 9 , 9 , and 8, then KTHLARGEST returns 9 for k=2 and 8 for 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 s lang vs sql

D s
snippetBasic

D lang syntax
RawWrangletrue
Typeref
showNotetrue
WrangleTextpivot value:kthlargestunique(myRating, 3) group:postal_code limit:1

kthlargestunique(myRating, 3)

Output: Returns the third highest unique value from the myRating column.

D s
snippetSyntax

D lang syntax
RawWrangletrue
Typesyntax
showNotetrue
WrangleTextpivot value:kthlargestunique(function_col_ref, k_integer) [ group:group_col_ref] [limit:limit_count]

kthlargestunique(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 unique 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. 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.

  • 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 unique value to extract from the source column. Duplicate values are treated as a single value for purposes of this function's calculation.

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