pandasx / DataFrameGroupBy

Class: DataFrameGroupBy<R>

Defined in: src/groupby.ts:239

R is what reductions return: a Series indexed by the group keys, or a DataFrame with the keys as columns when grouping with { asIndex: false }.

Extends

• BaseGroupBy

Type Parameters

Type Parameter	Default type
R extends Series | DataFrame	Series

Constructors

Constructor

new DataFrameGroupBy<R>(frame, by, options?, selection?, keyNames?): DataFrameGroupBy<R>

Defined in: src/groupby.ts:242

Parameters

Parameter	Type	Default value
frame	DataFrame	undefined
by	readonly string[]	undefined
options	GroupByOptions	{}
selection	readonly string[] | null	null
keyNames?	readonly (string | null)[]	undefined

Returns

DataFrameGroupBy<R>

Overrides

BaseGroupBy.constructor

Accessors

groups

Get Signature

get groups(): Map<Label, Label[]>

Defined in: src/groupby.ts:125

Group label → index labels of its rows (pandas .groups).

Returns

Map<Label, Label[]>

Inherited from

BaseGroupBy.groups

---

indices

Get Signature

get indices(): Map<Label, number[]>

Defined in: src/groupby.ts:187

Group label → row positions.

Returns

Map<Label, number[]>

Inherited from

BaseGroupBy.indices

---

ngroups

Get Signature

get ngroups(): number

Defined in: src/groupby.ts:109

Returns

number

Inherited from

BaseGroupBy.ngroups

Methods

[iterator]()

[iterator](): IterableIterator<[Label, DataFrame]>

Defined in: src/groupby.ts:459

Returns

IterableIterator<[Label, DataFrame]>

---

agg()

agg(spec): DataFrame

Defined in: src/groupby.ts:303

Aggregates groups.

• 'sum' / function: applied to every value column.
• ['sum', 'mean']: one output column per (column, func), named col_func.
• {a: 'sum', b: ['min', 'max']}: per-column functions (b_min, b_max).
• {total: ['a', 'sum']}: named aggregation, like agg(total=('a', 'sum')).

Parameters

Parameter	Type
spec	AggSpec

Returns

DataFrame

---

aggregate()

aggregate(spec): DataFrame

Defined in: src/groupby.ts:337

Parameters

Parameter	Type
spec	AggSpec

Returns

DataFrame

---

all()

all(): DataFrame

Defined in: src/groupby.ts:413

Returns

DataFrame

---

any()

any(): DataFrame

Defined in: src/groupby.ts:412

Returns

DataFrame

---

apply()

apply(fn): DataFrame | Series

Defined in: src/groupby.ts:345

Calls fn(groupFrame, key) per group. Scalar results → Series; Series results → DataFrame (one row per group); DataFrame results → concatenated frame.

Parameters

Parameter	Type
fn	(group, key) => unknown

Returns

DataFrame | Series

---

bfill()

bfill(limit?): DataFrame

Defined in: src/groupby.ts:423

Parameters

Parameter	Type
limit?	number

Returns

DataFrame

---

count()

count(): DataFrame

Defined in: src/groupby.ts:291

Returns

DataFrame

---

cumcount()

cumcount(options?): Series

Defined in: src/groupby.ts:139

0-based position of each row within its group.

Parameters

Parameter	Type
options	{ ascending?: boolean; }
options.ascending?	boolean

Returns

Series

Inherited from

BaseGroupBy.cumcount

---

cummax()

cummax(): DataFrame

Defined in: src/groupby.ts:420

Returns

DataFrame

---

cummin()

cummin(): DataFrame

Defined in: src/groupby.ts:421

Returns

DataFrame

---

cumprod()

cumprod(): DataFrame

Defined in: src/groupby.ts:419

Returns

DataFrame

---

cumsum()

cumsum(): DataFrame

Defined in: src/groupby.ts:418

Returns

DataFrame

---

describe()

describe(): DataFrame

Defined in: src/groupby.ts:441

Summary statistics per group, one column_stat column per statistic.

Returns

DataFrame

---

diff()

diff(periods?): DataFrame

Defined in: src/groupby.ts:415

Parameters

Parameter	Type	Default value
periods	number	1

Returns

DataFrame

---

ewm()

ewm(options): GroupedOperation

Defined in: src/groupby.ts:157

Parameters

Parameter	Type
options	EwmOptions

Returns

GroupedOperation

Inherited from

BaseGroupBy.ewm

---

expanding()

expanding(options?): GroupedOperation

Defined in: src/groupby.ts:153

Parameters

Parameter	Type
options	{ minPeriods?: number; }
options.minPeriods?	number

Returns

GroupedOperation

Inherited from

BaseGroupBy.expanding

---

ffill()

ffill(limit?): DataFrame

Defined in: src/groupby.ts:422

Parameters

Parameter	Type
limit?	number

Returns

DataFrame

---

fillna()

fillna(value): DataFrame

Defined in: src/groupby.ts:424

Parameters

Parameter	Type
value	unknown

Returns

DataFrame

---

filter()

filter(fn): DataFrame

Defined in: src/groupby.ts:375

Rows of the groups for which fn(group) is true.

Parameters

Parameter	Type
fn	(group, key) => boolean

Returns

DataFrame

---

first()

first(): DataFrame

Defined in: src/groupby.ts:292

Returns

DataFrame

---

get()

Call Signature

get(column): SeriesGroupBy<R>

Defined in: src/groupby.ts:256

groupby(...).get('col') ≈ groupby(...)['col'].

Parameters

Parameter	Type
column	string

Returns

SeriesGroupBy<R>

Call Signature

get(columns): DataFrameGroupBy<R>

Defined in: src/groupby.ts:257

groupby(...).get('col') ≈ groupby(...)['col'].

Parameters

Parameter	Type
columns	readonly string[]

Returns

DataFrameGroupBy<R>

---

getGroup()

getGroup(key): DataFrame

Defined in: src/groupby.ts:451

Parameters

Parameter	Type
key	Label

Returns

DataFrame

---

head()

head(n?): DataFrame

Defined in: src/groupby.ts:381

First n rows of each group, in original order.

Parameters

Parameter	Type	Default value
n	number	5

Returns

DataFrame

---

idxmax()

idxmax(): DataFrame

Defined in: src/groupby.ts:427

Returns

DataFrame

---

idxmin()

idxmin(): DataFrame

Defined in: src/groupby.ts:428

Returns

DataFrame

---

last()

last(): DataFrame

Defined in: src/groupby.ts:293

Returns

DataFrame

---

max()

max(): DataFrame

Defined in: src/groupby.ts:290

Returns

DataFrame

---

mean()

mean(): DataFrame

Defined in: src/groupby.ts:285

Returns

DataFrame

---

median()

median(): DataFrame

Defined in: src/groupby.ts:286

Returns

DataFrame

---

min()

min(): DataFrame

Defined in: src/groupby.ts:289

Returns

DataFrame

---

ngroup()

ngroup(options?): Series

Defined in: src/groupby.ts:131

Group number of each row (NaN for rows whose key was dropped).

Parameters

Parameter	Type
options	{ ascending?: boolean; }
options.ascending?	boolean

Returns

Series

Inherited from

BaseGroupBy.ngroup

---

nth()

nth(n): DataFrame

Defined in: src/groupby.ts:431

n-th row(s) of each group (negative counts from the end), keeping the original index.

Parameters

Parameter	Type
n	number | readonly number[]

Returns

DataFrame

---

nunique()

nunique(): DataFrame

Defined in: src/groupby.ts:294

Returns

DataFrame

---

pctChange()

pctChange(periods?): DataFrame

Defined in: src/groupby.ts:416

Parameters

Parameter	Type	Default value
periods	number	1

Returns

DataFrame

---

pipe()

pipe<T>(fn): T

Defined in: src/groupby.ts:167

Calls fn(this), for method chaining.

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
fn	(g) => T

Returns

T

Inherited from

BaseGroupBy.pipe

---

prod()

prod(): DataFrame

Defined in: src/groupby.ts:284

Returns

DataFrame

---

quantile()

quantile(q?): DataFrame

Defined in: src/groupby.ts:426

Parameters

Parameter	Type	Default value
q	number	0.5

Returns

DataFrame

---

rank()

rank(options?): DataFrame

Defined in: src/groupby.ts:417

Parameters

Parameter	Type
options	RankOptions

Returns

DataFrame

---

resample()

resample(rule, options?): GroupedOperation

Defined in: src/groupby.ts:162

Time resampling within each group.

Parameters

Parameter	Type
rule	string
options	ResampleOptions

Returns

GroupedOperation

Inherited from

BaseGroupBy.resample

---

rolling()

rolling(window, options?): GroupedOperation

Defined in: src/groupby.ts:149

Rolling window within each group; results are indexed by (group key, original label).

Parameters

Parameter	Type
window	string | number
options	RollingOptions

Returns

GroupedOperation

Inherited from

BaseGroupBy.rolling

---

sample()

sample(n?, options?): DataFrame

Defined in: src/groupby.ts:436

n random rows per group.

Parameters

Parameter	Type	Default value
n	number	1
options	{ seed?: number; }	{}
options.seed?	number	undefined

Returns

DataFrame

---

sem()

sem(): DataFrame

Defined in: src/groupby.ts:411

Returns

DataFrame

---

shift()

shift(periods?): DataFrame

Defined in: src/groupby.ts:414

Parameters

Parameter	Type	Default value
periods	number	1

Returns

DataFrame

---

size()

size(): Series

Defined in: src/groupby.ts:267

Rows per group.

Returns

Series

---

std()

std(): DataFrame

Defined in: src/groupby.ts:287

Returns

DataFrame

---

sum()

sum(): DataFrame

Defined in: src/groupby.ts:283

Returns

DataFrame

---

tail()

tail(n?): DataFrame

Defined in: src/groupby.ts:385

Parameters

Parameter	Type	Default value
n	number	5

Returns

DataFrame

---

transform()

transform(func): DataFrame

Defined in: src/groupby.ts:365

Same-shaped result: each value replaced by its group's aggregate (or fn(series)).

Parameters

Parameter	Type
func	AggName | ((s) => unknown)

Returns

DataFrame

---

var()

var(): DataFrame

Defined in: src/groupby.ts:288

Returns

DataFrame