g_mode(G;S;X)

Returns the mode of values within a given group.

Function type

Vector only

Syntax

g_mode(G;S;X)

Input

Argument Type Description
G any A space- or comma-separated list of column names

Rows are in the same group if their values for all of the columns listed in G are the same.

If G is omitted, all rows are considered to be in the same group.

If any of the columns listed in G contain N/A, the N/A value is considered a valid grouping value.

S integer The name of a column in which every row evaluates to a 1 or 0, which determines whether or not that row is selected to be included in the calculation

If S is omitted, all rows will be considered by the function (subject to any prior row selections).

If any of the values in S are neither 1 nor 0, an error is returned.

X any numeric type A column name

N/As in X are ignored (i.e., the result is the mode of the non-N/A values).

Return Value

For every row in each group defined by G (and for those rows where S=1, if specified), g_mode returns a decimal value corresponding to the mode of the values in the column listed in X that are in the same group as that row. If, for a given group, there is no unique mode, the result is arbitrary.

If all values for a particular group are N/A, the result is N/A.

Sample Usage

<base table="pub.doc.samples.ref.func.g_func_sample_usage"/>
<willbe name="g_mode_1" value="g_mode(state;include;value)"/>
<willbe name="g_mode_2" value="g_mode(state city;include;value)"/>