`dataFrame.column.compare — closestTo()`

Description

The closestTo() method of the compare object returns a boolean mask indicating which rows contain the value closest to the specified number. Multiple matches may be returned when distances are equal.

Signature

dataFrame.column(columnName).compare.closestTo(number)

Scope: column
Family: compare
Returns: mask

Arguments

columnName (string): The name of the column to compare values from.
number (number): The reference value used for the comparison.

Returns

mask ( boolean[] )

A boolean mask indicating the rows whose values are closest to the specified number.

Closest to the number: 1
Otherwise: 0

Example

// higlight rows where the 'revenue' value is closest to 2000
var mask = df.column('revenue').compare.closestTo(2000);

// set mask to dataFrame
df.column('revenue_2k').set(mask)