head_by

head_by returns the first n rows for each group.

Syntax

Parameters

ParameterTypeDescription
nint

The number of rows to return for each group.

by optionalUnion[str, list[str]]

The column(s) by which to group data.

  • ["X"] will output the entire first n row(s) of each group in column X.
  • ["X", "Y"] will output the entire first n row(s) of each group designated from the X and Y columns.

Returns

A new table containing the first n rows for each group.

Examples

In this example, head_by returns the first 2 rows, as grouped by X.

In this example, head_by returns the first 2 rows, as grouped by X and Y.