Skip to main content
This function calculates the percentile rank for each non-null value in a single-valued numeric or date column. Percentile ranks are assigned based on the relative position of each value in the sorted column, with results ranging [0, 1). Null values are preserved and do not affect the ranking. The function does not support multi-valued columns.

​
Usage

The following example shows how the step can be used in a recipe.

Examples

  • Example 1
  • Signature
The following example calculates the percentile rank for a column of numerical values, producing a new numerical column where each value is ranked between 0 and 1.
percentile_rank(ds.age, {}) -> (ds.age_percentile)

​
Inputs & Outputs

The following are the inputs expected by the step and the outputs it produces. These are generally columns (ds.first_name), datasets (ds or ds[["first_name", "last_name"]]) or models (referenced by name e.g. "churn-clf").
​
input
column[number]
required
A single-valued numeric or date column for percentile ranking.
​
output
column[number]
required
A new numerical column containing the percentile ranks for each value.

​
Configuration

The following parameters can be used to configure the behaviour of the step by including them in a json object as the last “input” to the step, i.e. step(..., {"param": "value", ...}) -> (output).

Parameters

This step expects not to receive any parameters.