Skip to main content
By default the order is identical to that in the input dataset, and row indices will be used to decide any ties found. If you’re selecting a list-like column, only the highest (ascending) or lowest (descending) value of the column will be used for sorting.

Usage

The following examples show how the step can be used in a recipe.

Examples

  • Example 1
  • Example 2
  • Signature
Order table rows from highest to lowest salary
configure_rows_order(ds.salary, { "order": "ascending" })

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").
column_to_order
column
required
Column to be used to order the rows.

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

order
string
required
Sort direction to be applied to data table rows order.Values must be one of the following:
  • ascending
  • descending
I