stat.md

Table of Contents

• Stat
  • Parameters
  • sum
    • Parameters
    • Examples
  • max
    • Parameters
    • Examples
  • min
    • Parameters
    • Examples
  • mean
    • Parameters
    • Examples
  • average
    • Parameters
    • Examples
  • var
    • Parameters
    • Examples
  • sd
    • Parameters
    • Examples
  • stats
    • Parameters
    • Examples

Stat

src/modules/stat.js:6-154

Stat module for DataFrame, providing basic statistical metrics for numeric columns.

Parameters

• df DataFrame An instance of DataFrame.

sum

src/modules/stat.js:29-39

Compute the sum of a numeric column.

Parameters

• columnName String The column to evaluate, containing Numbers.

Examples

df.stat.sum('column1')

Returns Number The sum of the column.

max

src/modules/stat.js:48-52

Compute the maximal value into a numeric column.

Parameters

• columnName String The column to evaluate, containing Numbers.

Examples

df.stat.max('column1')

Returns Number The maximal value into the column.

min

src/modules/stat.js:61-65

Compute the minimal value into a numeric column.

Parameters

• columnName String The column to evaluate, containing Numbers.

Examples

df.stat.min('column1')

Returns Number The minimal value into the column.

mean

src/modules/stat.js:74-87

Compute the mean value into a numeric column.

Parameters

• columnName String The column to evaluate,isNumber(n.get(columnName)) ? p + Number( containing Numbers.

Examples

df.stat.mean('column1')

Returns Number The mean value into the column.

average

src/modules/stat.js:97-99

Compute the mean value into a numeric column. Alias from mean.

Parameters

• columnName String The column to evaluate, containing Numbers.

Examples

df.stat.min('column1')

Returns Number The mean value into the column.

var

src/modules/stat.js:109-121

Compute the variance into a numeric column.

Parameters

• columnName String The column to evaluate, containing Numbers.
• population Boolean Population mode. If true, provide the population variance, not the sample one. (optional, default false)

Examples

df.stat.var('column1')

Returns Number The variance into the column.

sd

src/modules/stat.js:131-133

Compute the standard deviation into a numeric column.

Parameters

• columnName String The column to evaluate, containing Numbers.
• population Boolean Population mode. If true, provide the population standard deviation, not the sample one. (optional, default false)

Examples

df.stat.sd('column1')

Returns Number The standard deviation into the column.

stats

src/modules/stat.js:142-153

Compute all the stats available with the Stat module on a numeric column.

Parameters

• columnName String The column to evaluate, containing Numbers.

Examples

df.stat.stats('column1')

Returns Object An dictionnary containing all statistical metrics available.