group: Group by One or More Variables

In tesselle/nexus: Sourcing Archaeological Materials by Chemical Composition

Group by One or More Variables

Description

Define or remove the (reference) groups to which the observations belong.

Usage

group(object, ...)

ungroup(object, ...)

## S4 method for signature 'CompositionMatrix'
group(object, by, verbose = getOption("nexus.verbose"), ...)

## S4 method for signature 'GroupedComposition'
group(object, by, add = FALSE, verbose = getOption("nexus.verbose"), ...)

## S4 method for signature 'GroupedComposition'
ungroup(object)

## S4 method for signature 'GroupedLR'
ungroup(object)

## S4 method for signature 'GroupedCLR'
ungroup(object)

## S4 method for signature 'GroupedALR'
ungroup(object)

## S4 method for signature 'GroupedILR'
ungroup(object)

## S4 method for signature 'GroupedPLR'
ungroup(object)

Arguments

object	An R object (typically, a CompositionMatrix object).
...	Further parameters to be passed to internal methods.
by	A possible value for the groups of object (typically, a character vector). If value is a list, interaction(by) defines the grouping.
verbose	A logical scalar: should R report extra information on progress?
add	A logical scalar. If TRUE, add to existing groups.

Details

Missing values (NA) can be used to specify that a sample does not belong to any group.

Value

• group() returns a grouped object of the same sort as object.

• ungroup() returns an ungrouped object of the same sort as object.

Author(s)

N. Frerebeau

See Also

Other grouping methods: group_names(), group_split(), group_subset(), is_assigned()

Examples

## Data from Aitchison 1986
data("slides")

## Coerce to compositional data
coda <- as_composition(slides, groups = 2)

## Grouping metadata
group_levels(coda)

group_names(coda)

group_indices(coda)

group_rows(coda)

group_n(coda)

group_size(coda)

tesselle/nexus documentation built on June 1, 2025, 9:04 p.m.