Skip to contents

collapse provides the following functions to efficiently group and order data:

  • radixorder, provides fast radix-ordering through direct access to the method order(..., method = "radix"), as well as the possibility to return some attributes very useful for grouping data and finding unique elements. radixorderv exists as a programmers alternative. The function roworder(v) efficiently reorders a data frame based on an ordering computed by radixorderv.

  • group provides fast grouping in first-appearance order of rows, based on a hashing algorithm in C. Objects have class 'qG', see below.

  • GRP creates collapse grouping objects of class 'GRP' based on radixorderv or group. 'GRP' objects form the central building block for grouped operations and programming in collapse and are very efficient inputs to all collapse functions supporting grouped operations.

  • fgroup_by provides a fast replacement for dplyr::group_by, creating a grouped data frame (or data.table / tibble etc.) with a 'GRP' object attached. This grouped frame can be used for grouped operations using collapse's fast functions.

  • fmatch is a fast alternative to match, which also supports matching of data frame rows.

  • funique is a faster version of unique. The data frame method also allows selecting unique rows according to a subset of the columns. fnunique efficiently calculates the number of unique values/rows. fduplicated is a fast alternative to duplicated. any_duplicated is a simpler and faster alternative to anyDuplicated.

  • fcount computes group counts based on a subset of columns in the data, and is a fast replacement for dplyr::count. fcountv is a programmers version of the function.

  • qF, shorthand for 'quick-factor' implements very fast factor generation from atomic vectors using either radix ordering method = "radix" or hashing method = "hash". Factors can also be used for efficient grouped programming with collapse functions, especially if they are generated using qF(x, na.exclude = FALSE) which assigns a level to missing values and attaches a class 'na.included' ensuring that no additional missing value checks are executed by collapse functions.

  • qG, shorthand for 'quick-group', generates a kind of factor-light without the levels attribute but instead an attribute providing the number of levels. Optionally the levels / groups can be attached, but without converting them to character. Objects have a class 'qG', which is also recognized in the collapse ecosystem.

  • fdroplevels is a substantially faster replacement for droplevels.

  • finteraction is a fast alternative to interaction implemented as a wrapper around as_factor_GRP(GRP(...)). It can be used to generate a factor from multiple vectors, factors or a list of vectors / factors. Unused factor levels are always dropped.

  • groupid is a generalization of data.table::rleid providing a run-length type group-id from atomic vectors. It is generalization as it also supports passing an ordering vector and skipping missing values. For example qF and qG with method = "radix" are essentially implemented using groupid(x, radixorder(x)).

  • seqid is a specialized function which creates a group-id from sequences of integer values. For any regular panel dataset groupid(id, order(id, time)) and seqid(time, order(id, time)) provide the same id variable. seqid is especially useful for identifying discontinuities in time-sequences.

  • timeid is a specialized function to convert integer or double vectors representing time (such as 'Date', 'POSIXct' etc.) to factor or 'qG' object based on the greatest common divisor of elements (thus preserving gaps in time intervals).

Table of Functions

Function / S3 Generic Methods Description
radixorder(v)No methods, for data frames and vectorsRadix-based ordering + grouping information
roworder(v)No methods, for data frames incl. pdata.frameRow sorting/reordering
groupNo methods, for data frames and vectorsHash-based grouping + grouping information
GRPdefault, GRP, factor, qG, grouped_df, pseries, pdata.frameFast grouping and a flexible grouping object
fgroup_byNo methods, for data framesFast grouped data frame
fmatchNo methods, for vectors and data framesFast matching
funique, fnunique, fduplicated, any_duplicateddefault, data.frame, sf, pseries, pdata.frame, listFast (number of) unique values/rows
fcount(v)Internal generic, supports vectors, matrices, data.frames, lists, grouped_df and pdata.frameFast group counts
qFNo methods, for vectorsQuick factor generation
qGNo methods, for vectorsQuick grouping of vectors and a 'factor-light' class
fdroplevelsfactor, data.frame, listFast removal of unused factor levels
finteractionNo methods, for data frames and vectorsFast interactions
groupidNo methods, for vectorsRun-length type group-id
seqidNo methods, for integer vectorsRun-length type integer sequence-id
timeidNo methods, for integer or double vectorsInteger-id from time/date sequences