Class: GroupByBuilder
dg.GroupByBuilder
Fluid API for building an aggregation query against a DataFrame. Build a query by calling the following methods: key, pivot, count, uniqueCount, missingValueCount, valueCount, min, max, sum, avg, stdev, variance, q1, q2, q3.
When the query is constructed, execute it by calling aggregate, which will produce a DataFrame.
See samples: https://public.datagrok.ai/js/samples/data-frame/aggregation
Example
let avgAgesByRaceAndSex = demographicsTable
.groupBy(['race', 'sex'])
.avg('age')
.aggregate();
Constructors
constructor
• new GroupByBuilder(dart
)
Parameters
Name | Type |
---|---|
dart | any |
Defined in
Properties
dart
• Private
Readonly
dart: any
Defined in
Methods
add
▸ add(agg
, colName?
, resultColName?
): GroupByBuilder
Performs the aggregation
Parameters
Name | Type | Description |
---|---|---|
agg | "values" | "max" | "key" | "first" | "count" | "unique" | "nulls" | "min" | "sum" | "med" | "avg" | "stdev" | "variance" | "skew" | "kurt" | "q1" | "q2" | "q3" | "pivot" | "#selected" | Aggregation type. |
colName? | null | string | Column name. |
resultColName? | null | string | Name of the resulting column. Default value is agg(colName). |
Returns
Defined in
aggregate
▸ aggregate(): DataFrame
Performs the aggregation
Returns
Defined in
avg
▸ avg(srcColName
, resultColName?
): GroupByBuilder
Adds an aggregation that calculates average value for the specified column. Call aggregate when the query is constructed.
Parameters
Name | Type | Default value | Description |
---|---|---|---|
srcColName | string | undefined | column name in the source table |
resultColName? | null | string | null | column name in the resulting DataFrame |
Returns
Defined in
count
▸ count(resultColName?
): GroupByBuilder
Adds an aggregation that counts rows, including these will null values. See also count, valueCount, uniqueCount, missingValueCount Call aggregate when the query is constructed.
Parameters
Name | Type | Default value | Description |
---|---|---|---|
resultColName? | string | 'count' | column name in the resulting DataFrame |
Returns
Defined in
first
▸ first(srcColName
, resultColName?
): GroupByBuilder
Adds an aggregation that takes first value for the specified column. Call aggregate when the query is constructed.
Parameters
Name | Type | Default value | Description |
---|---|---|---|
srcColName | string | undefined | column name in the source table |
resultColName? | null | string | null | column name in the resulting DataFrame |
Returns
Defined in
getGroups
▸ getGroups(): Map
<string
, DataFrame
>
Gets groups of DataFrames
Returns
Map
<string
, DataFrame
>
- where keys are stings in format 'columnName=value' and values are DataFrames
Defined in
key
▸ key(srcColName
, resultColName?
): GroupByBuilder
Adds a key column to group values on. Call aggregate when the query is constructed.
Parameters
Name | Type | Default value | Description |
---|---|---|---|
srcColName | string | undefined | column name in the source table |
resultColName? | null | string | null | column name in the resulting DataFrame |
Returns
Defined in
max
▸ max(srcColName
, resultColName?
): GroupByBuilder
Adds an aggregation that calculates maximum value for the specified column. Call aggregate when the query is constructed.
Parameters
Name | Type | Default value | Description |
---|---|---|---|
srcColName | string | undefined | column name in the source table |
resultColName? | null | string | null | column name in the resulting DataFrame |
Returns
Defined in
med
▸ med(srcColName
, resultColName?
): GroupByBuilder
Adds an aggregation that calculates median value for the specified column. Call aggregate when the query is constructed.
Parameters
Name | Type | Default value | Description |
---|---|---|---|
srcColName | string | undefined | column name in the source table |
resultColName? | null | string | null | column name in the resulting DataFrame |
Returns
Defined in
min
▸ min(srcColName
, resultColName?
): GroupByBuilder
Adds an aggregation that calculates minimum value for the specified column. Call aggregate when the query is constructed.
Parameters
Name | Type | Default value | Description |
---|---|---|---|
srcColName | string | undefined | column name in the source table |
resultColName? | null | string | null | column name in the resulting DataFrame |
Returns
Defined in
missingValueCount
▸ missingValueCount(srcColName
, resultColName?
): GroupByBuilder
Adds an aggregation that counts number of missing values in the specified column. See also count, valueCount, uniqueCount, missingValueCount Call aggregate when the query is constructed.
Parameters
Name | Type | Default value | Description |
---|---|---|---|
srcColName | string | undefined | column name in the source table |
resultColName? | null | string | null | column name in the resulting DataFrame |
Returns
Defined in
pivot
▸ pivot(srcColName
, resultColName?
): GroupByBuilder
Adds a column to pivot values on. Call aggregate when the query is constructed.
Parameters
Name | Type | Default value | Description |
---|---|---|---|
srcColName | string | undefined | column name in the source table |
resultColName? | null | string | null | column name in the resulting DataFrame |
Returns
Defined in
q1
▸ q1(srcColName
, resultColName?
): GroupByBuilder
Adds an aggregation that calculates first quartile for the specified column. Call aggregate when the query is constructed.
Parameters
Name | Type | Default value | Description |
---|---|---|---|
srcColName | string | undefined | column name in the source table |
resultColName? | null | string | null | column name in the resulting DataFrame |
Returns
Defined in
q2
▸ q2(srcColName
, resultColName?
): GroupByBuilder
Adds an aggregation that calculates second quartile for the specified column. Call aggregate when the query is constructed.
Parameters
Name | Type | Default value | Description |
---|---|---|---|
srcColName | string | undefined | column name in the source table |
resultColName? | null | string | null | column name in the resulting DataFrame |
Returns
Defined in
q3
▸ q3(srcColName
, resultColName?
): GroupByBuilder
Adds an aggregation that calculates third quartile for the specified column. Call aggregate when the query is constructed.
Parameters
Name | Type | Default value | Description |
---|---|---|---|
srcColName | string | undefined | column name in the source table |
resultColName? | null | string | null | column name in the resulting DataFrame |
Returns
Defined in
stdev
▸ stdev(srcColName
, resultColName?
): GroupByBuilder
Adds an aggregation that calculates standard deviation for the specified column. Call aggregate when the query is constructed.
Parameters
Name | Type | Default value | Description |
---|---|---|---|
srcColName | string | undefined | column name in the source table |
resultColName? | null | string | null | column name in the resulting DataFrame |
Returns
Defined in
sum
▸ sum(srcColName
, resultColName?
): GroupByBuilder
Adds an aggregation that calculates sum of the values for the specified column. Call aggregate when the query is constructed.
Parameters
Name | Type | Default value | Description |
---|---|---|---|
srcColName | string | undefined | column name in the source table |
resultColName? | null | string | null | column name in the resulting DataFrame |
Returns
Defined in
toString
▸ toString(): string
Returns
string
Defined in
uniqueCount
▸ uniqueCount(srcColName
, resultColName?
): GroupByBuilder
Adds an aggregation that counts number of unique values in the specified column. See also count, valueCount, missingValueCount Call aggregate when the query is constructed.
Parameters
Name | Type | Default value | Description |
---|---|---|---|
srcColName | string | undefined | column name in the source table |
resultColName? | null | string | null | column name in the resulting DataFrame |
Returns
Defined in
valueCount
▸ valueCount(srcColName
, resultColName?
): GroupByBuilder
Adds an aggregation that counts rows, including these will null values. See also count, valueCount, uniqueCount, missingValueCount Call aggregate when the query is constructed.
Parameters
Name | Type | Default value | Description |
---|---|---|---|
srcColName | string | undefined | column name in the source table |
resultColName? | null | string | null | column name in the resulting DataFrame |
Returns
Defined in
variance
▸ variance(srcColName
, resultColName?
): GroupByBuilder
Adds an aggregation that calculates varians for the specified column. Call aggregate when the query is constructed.
Parameters
Name | Type | Default value | Description |
---|---|---|---|
srcColName | string | undefined | column name in the source table |
resultColName? | null | string | null | column name in the resulting DataFrame |
Returns
Defined in
where
▸ where(pattern
): GroupByBuilder
Specifies the filter for the source rows.
Input
pattern
Parameters
Name | Type |
---|---|
pattern | string | object |
Returns
Defined in
whereRowMask
▸ whereRowMask(bitset
): GroupByBuilder
Parameters
Name | Type |
---|---|
bitset | BitSet |