Default grouping

Sets and extracts the active (default) grouping. Useful to save typing in functions that require a grouping variable as input. (Usually referred to via arguments across or grouping / grouping_variable).

activateGrouping(object, grouping, verbose = NULL)

activeGrouping(object, verbose = NULL, arg = "across")

Arguments

object

An object of class SPATA2 or, in case of S4 generics, objects of classes for which a method has been defined.

grouping

Character value. The grouping variable that is supposed to be used by default within all functions that need one.

verbose

Logical. If TRUE, informative messages regarding the computational progress will be printed.

(Warning messages will always be printed.)

Value

activateGrouping(): Updated SPATA2 object. activeGrouping(): Character value. Name of the default grouping variable.