Divide¶

Divide two or more numeric columns in given order.

An additional constant may be used to divide the final result by.

Usage¶

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

Step signature

divide(*columns: number, {
    "param": value
}) -> (result: number)

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.

Example¶

To simply divide one column by another:

Example call (in recipe editor)

divide(ds.numerator, ds.denominator) -> (ds.quotient)

More examples

To divide a single column by 2.0:

Example call (in recipe editor)

divide(ds.num_column, {"constant": 2.0}) -> (ds.result)

Inputs¶

*columns: column:number

One or more numeric columns to divide (left to right).

Outputs¶

result: column:number

The result of the division.

Parameters¶

constant: number

A constant to divide by.

ignore_nans: boolean = False

Whether to ignore NaNs or propagate them.