Skip to main content
The type of the output column depends on the component extracted. Where the component is a name (e.g. of the day of week), the result will be a categorical column. Otherwise it will be numeric.

​
Usage

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

Examples

  • Example 1
  • Signature
To extract the number of the month (1..12) from a date column:
extract_date_component(ds.date, {"component": "month"}) -> (ds.month)

​
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").
​
date
column[date]
required
A column of dates to extract the desired component from.
​
component
column
required
A numeric or categorical column containing the desired component.

​
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

​
component
string
default:"day"
required
The name of the date component to extract.Values must be one of the following:date day day_name dayofmonth dayofweek dayofyear hour minute month month_name part_of_day partofday period_of_day periodofday quarter season second time week weekday weekday_name weekofyear year
​
tz
string
default:"UTC"
The timezone to use when extracting the date component. The timezone to use when extracting the date component. If not specified, the timezone of the column metadata will be used. If the column metadata does not specify a timezone, UTC will be used. The expected format is [+/-]HH:MM, e.g. +01:00, 02:00, -05:00, +00:00, etc.