Skip to content

Configure category order

UI ยท interface

Configures the order of categories in a categorical or list of categories column.

Example

configure_category_order(ds.cluster, { "kind": "BACKGROUND" })

Usage

The following are the step's expected inputs and outputs and their specific types.

configure_category_order(column: category|list[category]|text, {"param": value})

where the object {"param": value} is optional in most cases and if present may contain any of the parameters described in the corresponding section below.

Inputs


column: column:category|list[category]|text

Categorical column to be configured (may be a column of lists of categories).

Parameters


kind: string

Kind of ordering. Determines the order of categories. E.g. to show first the categories having the greatest row count in the whole dataset, select "BACKGROUND". To show those categories first having the greatest number of rows in the current selection, use "FOREGROUND", etc.

Must be one of: "BACKGROUND", "FOREGROUND", "UPLIFT", "TFIDF", "ORDINAL"