Skip to main content
Sets a human-readable label, description, and/or number format for a column. The label replaces the column name in the UI. The description appears as a tooltip. The format uses d3-format syntax for number display (e.g. ",.2f" for two decimal places with thousands separator). This is a UI configuration step that affects how the project is displayed in Graphext. It applies to the dataset referenced in its inputs. If your recipe produces multiple datasets (e.g. a filtered dataset that is then passed to create_project alongside the original), you need to add separate configure steps for each dataset you want to configure.

Usage

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

Examples

configure_column_metadata(ds.avatar, { "label": "Photo", "description": "Profile image of a user" })

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
column
required
Column to be configured.

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

label
string
Label of the column.
description
string
Description of the column.
format
string
Format the column’s numbers using d3-format (e.g., ‘,.3f’ will format the number with 3 decimal places).