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

# filter_row_numbers

> Filter rows by row number. 

Keeps or drops rows with specific row numbers, i.e. based on their 0-based, consecutive integer index.

## Usage

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

<Accordion title="Examples" icon="code" defaultOpen="true">
  <Tabs>
    <Tab title="Example 1">
      To keep only rows with index 0, 2 and 4 (the first, third and fifth row)

      ```stan theme={null}
      filter_row_numbers(ds, {"row_numbers": [0, 2, 4]}) -> (ds_filtered)
      ```
    </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}
      filter_row_numbers(ds_in: dataset, {
          "param": value,
          ...
      }) -> (ds_out: dataset)
      ```
    </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="ds_in" type="dataset" required>
    An input dataset to filter.
  </ParamField>
</Accordion>

<Accordion title="Outputs" icon="right-from-bracket">
  <ParamField path="ds_out" type="dataset" required>
    A new dataset containing the same columns as the input dataset but only those rows passing the filter condition.
  </ParamField>
</Accordion>

## 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="row_numbers" type="array[integer]" required>
    Ids of the rows to filter.
    Excepts either a single row (as a number) or a list of row numbers.

    <Accordion title="Array items">
      <ParamField path="Item" type="integer">
        Each item in array.
      </ParamField>
    </Accordion>
  </ParamField>

  <ParamField path="exclude" type="boolean" default="false">
    if `true`, selected rows will be *excluded* from the resulting dataset.
  </ParamField>
</Accordion>