filter_containing

Includes or excludes rows of the input datset based on the values of a selected text or list column. Depending on the configuration, if the column contains any or all of the specified values, the corresponding rows will be kept or dropped in the output dataset. “Containment” here means texts in a text column containing one or more specified substrings (words), or lists in a list column containing one or more elements matching the specified values. See below for illustrative examples.

Usage

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

Examples

Example 1
Example 2
Signature

E.g., to keep only those rows whose values in the “address” column contain the text string “Madrid”:

filter_containing(ds, {"column": "address", "values": ["Madrid"]}) -> (ds_filtered)

Or, given a dataset with the column “jobs”, containing lists of one or more job categories in each row, to keep only those rows where the list includes the word “journalist” (ignoring the letter case, i.e. upper or lower case):

filter_containing(ds, {
  "column": "jobs",
  "values": ["journalist"],
  "case_sensitive": false
}) -> (ds_filtered)

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.

filter_containing(ds_in: dataset, {
    "param": value,
    ...
}) -> (ds_out: dataset)

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

Inputs

dataset

required

An input dataset to filter.

Outputs

dataset

required

A dataset containing the same columns as the input dataset, but including or excluding the matched 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

string (ds_in.column:text|list)

required

Name of column to be matched against the specified values.

[number, string, array[['number', 'string']]]

required

Values to be matched in each row to decide its inclusion or exclusion. May be a single value or a list of values to be matched.

Array items

[number, string]

Each item in array.

Examples

the
[‘the’, ‘cat’]
2
[2, 3]

boolean

default:"false"

If true, matching rows will be excluded from the output dataset. I.e., only rows not containing the specified values will be returned.

boolean

default:"false"

Rows must contain all specified value to pass filter, rather than any.

boolean

default:"true"

Text values must match case to pass filter.

⌘I

Analyse

Report

Prepare

Usage

Inputs & Outputs

Configuration

​Usage

​Inputs & Outputs

​Configuration

Usage

Inputs & Outputs

Configuration