Calculates the percentile for each value relative to the rest of the data set.
Produces a percentile for each row of input. The rows are ranked by the value defined in the PercentRankExpression property.
For this node, percentiles are defined as the percentage of all input values that fall below the current score. This definition parallels the Excel PERCENTRANK function. These percentiles are output in a separate field whose name is defined by the PercentileFieldName property. Percentiles are reported as floating point values without a percentage sign. In other words, for a value in the 20th percentile, its percentile field will contain the value ".2".
The input of this node either must be sorted by PercentRankExpression before entering the node or must be sorted via the SortInput property.
Properties
SortInput
Optionally specify whether to sort the input data. If set to True, sorts the input by PercentRankExpression. If set to False, then the data is assumed to have been sorted already and is not sorted by this node. The default value is False.
PercentRankExpression
Specify which value will be used to determine the percentiles for the input data. This
property could contain a simple field reference in the form fields['fieldName']
or a mathematical expression. This field cannot evaluate to a list or to a
non-numeric value. A value is required for this property.
PercentileFieldName
Optionally specify a name for the output field for percentile values. The default value is "_Percentile".
Reverse
If set to True then the percent rank is changed to report the percentage of all input values that are above the current value rather than below it. The default value is False.
Inputs and outputs
Inputs: in1.
Outputs: out1.