g_cumrunlen(G;S;O;X)
Returns the cumulative run length within a given group.
Function type
Vector only
Syntax
g_cumrunlen(G;S;O;X)
t_cumrunlen(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 |
integer | A column name Note: This column can only contain a 1 or
0 value (or is a computed column that evaluates to such)
for every row.
|
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_cumrunlen
returns an integer value equal to the number of successive
rows in the same group, up to and including this row, where
X
=1.
The count resets to 0 wherever X
=0.
Sample Usage
<base table="pub.doc.samples.ref.func.g_func_time_series_and_or"/> <willbe name="g_cumrunlen_1" value="g_cumrunlen(state;include;order;value)"/> <willbe name="g_cumrunlen_2" value="g_cumrunlen(state city;include;order;value)"/>
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.