Stats

Defined in: js-api/src/dataframe/stats.ts:30

Represents basic descriptive statistics calculated for a Column. See samples: https://public.datagrok.ai/js/samples/data-frame/stats

Constructors

Constructor

new Stats(dart): Stats

Defined in: js-api/src/dataframe/stats.ts:33

Parameters

Parameter	Type
dart	any

Returns

Stats

Accessors

avg

Get Signature

get avg(): number

Defined in: js-api/src/dataframe/stats.ts:83

Returns

number

average

---

kurt

Get Signature

get kurt(): number

Defined in: js-api/src/dataframe/stats.ts:103

Returns

number

kurtosis

---

max

Get Signature

get max(): number

Defined in: js-api/src/dataframe/stats.ts:73

Returns

number

maximum

---

med

Get Signature

get med(): number

Defined in: js-api/src/dataframe/stats.ts:108

Returns

number

median value

---

min

Get Signature

get min(): number

Defined in: js-api/src/dataframe/stats.ts:68

Returns

number

minimum

---

missingValueCount

Get Signature

get missingValueCount(): number

Defined in: js-api/src/dataframe/stats.ts:53

Number of missing (empty) values.

Returns

number

---

q1

Get Signature

get q1(): number

Defined in: js-api/src/dataframe/stats.ts:113

Returns

number

first quartile

---

q2

Get Signature

get q2(): number

Defined in: js-api/src/dataframe/stats.ts:118

Returns

number

second quartile

---

q3

Get Signature

get q3(): number

Defined in: js-api/src/dataframe/stats.ts:123

Returns

number

third quartile

---

skew

Get Signature

get skew(): number

Defined in: js-api/src/dataframe/stats.ts:98

Returns

number

skewness

---

stdev

Get Signature

get stdev(): number

Defined in: js-api/src/dataframe/stats.ts:88

Returns

number

standard deviation

---

sum

Get Signature

get sum(): number

Defined in: js-api/src/dataframe/stats.ts:78

Returns

number

sum

---

totalCount

Get Signature

get totalCount(): number

Defined in: js-api/src/dataframe/stats.ts:48

Total number of values (including missing values).

Returns

number

---

uniqueCount

Get Signature

get uniqueCount(): number

Defined in: js-api/src/dataframe/stats.ts:58

Number of unique values.

Returns

number

---

valueCount

Get Signature

get valueCount(): number

Defined in: js-api/src/dataframe/stats.ts:63

Number of non-empty values.

Returns

number

---

variance

Get Signature

get variance(): number

Defined in: js-api/src/dataframe/stats.ts:93

Returns

number

variance

Methods

corr()

corr(otherColumn): number

Defined in: js-api/src/dataframe/stats.ts:128

Pearson correlation between this column and another column.

Parameters

Parameter	Type
otherColumn	Column

Returns

number

---

cumSum()

cumSum(options?): Column

Defined in: js-api/src/dataframe/stats.ts:138

Running total of the column, as a new column. An empty value stays empty and is skipped. Rows outside of the mask these stats were created with (see fromColumn) stay empty and are not accumulated.

Parameters

Parameter	Type
options?	WindowOptions

Returns

Column

Example

df.col('amount')!.stats.cumSum({orderBy: ['date'], by: ['region']});

See

https://public.datagrok.ai/js/samples/data-frame/stats-window-functions

---

movingAvg()

movingAvg(window, options?): Column

Defined in: js-api/src/dataframe/stats.ts:148

Average over a trailing window of window rows, the current one included, as a new column. Empty values are ignored. The result is empty until the window holds minPeriods values (one by default).

Parameters

Parameter	Type
window	number
options?	WindowOptions & object

Returns

Column

Example

df.col('price')!.stats.movingAvg(7, {orderBy: ['date'], minPeriods: 7});

See

https://public.datagrok.ai/js/samples/data-frame/stats-window-functions

---

spearmanCorr()

spearmanCorr(otherColumn): number

Defined in: js-api/src/dataframe/stats.ts:131

Spearman correlation between this column and another column.

Parameters

Parameter	Type
otherColumn	Column

Returns

number

---

toString()

toString(): string

Defined in: js-api/src/dataframe/stats.ts:160

Returns

string

---

fromColumn()

static fromColumn(col, mask?): Stats

Defined in: js-api/src/dataframe/stats.ts:38

Calculates statistics for the specified column, optionally filtered by a mask.

Parameters

Parameter	Type	Default value
col	Column	undefined
mask	BitSet | null	null

Returns

Stats

---

fromValues()

static fromValues(values): Stats

Defined in: js-api/src/dataframe/stats.ts:43

Calculates statistics for the array of values.

Parameters

Parameter	Type
values	number[] | Int32Array<ArrayBufferLike> | Float32Array<ArrayBufferLike> | Int8Array<ArrayBufferLike> | Int16Array<ArrayBufferLike> | Float64Array<ArrayBufferLike>

Returns

Stats

---

histogramsByCategories()

static histogramsByCategories(valueColumn, catColumn): Int32Array<ArrayBufferLike>[]

Defined in: js-api/src/dataframe/stats.ts:155

Returns distributions of [valueColumn] for each category in [catColumn].

Parameters

Parameter	Type
valueColumn	Column
catColumn	Column

Returns

Int32Array<ArrayBufferLike>[]