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 Datetime 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 must be valid Datetime values.

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 2020-02-15,  2020-02-14, and 2020-02-14, then KTHLARGESTDATE returns 2020-02-14 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 must be Datetime type. Other values column are ignored. If a row contains a missing or null value, it is not factored into the calculation.

For a version of this function that applies to non-Datetime values, see KTHLARGEST Function.

D s lang vs sql

D s
snippetBasic

D lang syntax
RawWrangletrue
Typeref
showNotetrue
WrangleTextpivot value:kthlargestdate(myDate, 2) group:postal_code limit:1

kthlargestdate(myDate, 2)

Output: Returns the second highest Datetime value from the myDate column. 

D s
snippetSyntax

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

kthlargestdate(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. Inputs must be Datetime 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)transactionDate

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

Example - KTHLARGESTDATE functions

Include Page
EXAMPLE - KTHLARGESTDATE Functions
EXAMPLE - KTHLARGESTDATE Functions

D s also
labeldate