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, when a specified condition is met. The value for k must be between 1 and 1000, inclusive. Inputs must be Datetime.

KTHLARGESTDATEIF calculations are filtered by a conditional applied to the group.  

For purposes of this calculation, two instances of the same value are treated as the same value of k. So, if your dataset contains three rows with column values 2020-02-15,  2020-02-14, and  2020-02-14, then KTHLARGESTDATEIF returns 2020-02-14 for k=2 and 2020-02-14 for k=3.

Input column must be of 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 on Datetime values without conditionals, use the KTHLARGESTDATE function. See KTHLARGESTDATE Function.

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

D s lang vs sql

D s
snippetBasic

D lang syntax
RawWrangletrue
Typeref
showNotetrue
WrangleTextpivot value: kthlargestdateif(transDate, 2, salesPerson == 'jsmith') limit:1

kthlargestdateif(transDate, 2, salesPerson == 'jsmith')

Output: Returns the secondmost recent Date (rank=2) from the transDate column when the salesPerson value is jsmith.

D s
snippetSyntax

D lang syntax
RawWrangletrue
Typesyntax
showNotetrue
WrangleTextpivot value:kthlargestdateif(col_ref, limit, test_expression) [group:group_col_ref] [limit:limit_count]

kthlargestdateif(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 Datetime values.

D s
snippetusage

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

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 - KTHLARGESTDATE functions

Include Page
EXAMPLE - KTHLARGESTDATE Functions
EXAMPLE - KTHLARGESTDATE Functions

D s also
labelaggregate