headPct

The headPct method returns a table with a specific percentage of rows from the beginning of the source table.

Caution

Attempting to use headPct on a blink table will raise an error.

Syntax

table.headPct(percent)

Parameters

ParameterTypeDescription
percentdouble

The percentage of rows to return. This value must be given as a floating-point number between 0 (0%) to 1 (100%).

Returns

A new table with a specific percentage of rows from the beginning of the source table.

Examples

The following example filters the table to the first 40% and 33.33333333333% of rows.

source = newTable(
    stringCol("Letter", "A", "C", "F", "B", "E", "D", "A"),
    intCol("Number", NULL_INT, 2, 1, NULL_INT, 4, 5, 3),
    stringCol("Color", "red", "blue", "orange", "purple", "yellow", "pink", "blue"),
    intCol("Code", 12, 13, 11, NULL_INT, 16, 14, NULL_INT),
)

result = source.headPct(0.40)
result1 = source.headPct(0.3333333333333)