dataFrame.column.compare — regExp()

Description

The regExp() method of the compare object returns a boolean mask indicating which values match the specified regular expression pattern.

Signature

dataFrame.column(columnName).compare.regExp(pattern)
Scope
column
Family
compare
Returns
mask

Arguments

columnName (string)
The name of the column to compare values from.
pattern (string)
The regular expression pattern to match against.

Returns

mask ( boolean[] )
A boolean mask indicating the rows whose values match the specified regular expression pattern.
  • Match the pattern: 1
  • Otherwise: 0

Example

// higlight rows where the column 'name' matches a regular expression pattern
var mask = df.column('name').compare.regExp('o.*n');

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