> ## Documentation Index
> Fetch the complete documentation index at: https://docs.graphext.com/llms.txt
> Use this file to discover all available pages before exploring further.

# configure_rows_order

> Configures the order of the rows in the Data section. 

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.

<Accordion title="Examples" icon="code" defaultOpen="true">
  <Tabs>
    <Tab title="Example 1">
      Order table rows from highest to lowest salary

      ```stan theme={null}
      configure_rows_order(ds.salary, { "order": "ascending" })
      ```
    </Tab>

    <Tab title="Example 2">
      Order table rows from lowest to highest age

      ```stan theme={null}
      configure_rows_order(ds.age, { "order": "descending" })
      ```
    </Tab>

    <Tab title="Signature">
      General syntax for using the step in a recipe. Shows the inputs and outputs the step is expected to receive and will produce respectively. For futher details see sections below.

      ```stan theme={null}
      configure_rows_order(column_to_order: column, {
          "param": value,
          ...
      })
      ```
    </Tab>
  </Tabs>
</Accordion>

## 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"`).

<Accordion title="Inputs" icon="right-to-bracket">
  <ParamField path="column_to_order" type="column" required>
    Column to be used to order the rows.
  </ParamField>
</Accordion>

<Accordion title="Outputs" icon="right-from-bracket" />

## 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)`.

<Accordion title="Parameters" defaultOpen="true" icon="sliders">
  <ParamField path="order" type="string" required>
    Sort direction to be applied to data table rows order.

    Values must be one of the following:

    * `ascending`
    * `descending`
  </ParamField>
</Accordion>
