g_runs(G;S;O;X)
Returns the number of times that a value has changed from row to row within a given group.
Function type
Vector only
Syntax
g_runs(G;S;O;X)
t_runs(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 If If any of the columns listed in |
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
If any of the values in
|
O |
integer | A space- or comma-separated list of column names that
determine the row order within a particular group If
If any of the values in |
X |
any simple type | A column name |
Return Value
For every row in each group defined by G
and ordered by O
(and for those rows where S
=1, if specified),
g_runs
returns an integer value corresponding to the number of times up
to and including the current row that the value in X
has changed from row
to row.
The count starts at 0 for the first row in the group. The count remains constant so long as
the value in X
remains constant, and increments by 1 every time the value
in X
changes.
Sample Usage
<base table="pub.doc.samples.ref.func.g_func_time_series_moving"/> <willbe name="g_runs_1" value="g_runs(state;include;order;value1)"/> <willbe name="g_runs_2" value="g_runs(state city;include;order;value2)"/>
Additional Information
- The
t_
version of this function defaults theG
argument and omits theS
argument. The default forG
is set at table load time based on the organization of the table.