nexus (version 0.4.0)

group: Working With Groups

Description

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

Usage

group(object, ...)
ungroup(object, ...)
# S4 method for CompositionMatrix
group(object, by, verbose = getOption("nexus.verbose"), ...)
# S4 method for GroupedComposition
group(object, by, add = FALSE, verbose = getOption("nexus.verbose"), ...)
# S4 method for GroupedComposition
ungroup(object)
# S4 method for GroupedLR
ungroup(object)
# S4 method for GroupedCLR
ungroup(object)
# S4 method for GroupedALR
ungroup(object)
# S4 method for GroupedILR
ungroup(object)
# S4 method for GroupedPLR
ungroup(object)

Value

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

• ungroup() returns an ungrouped object of the same sort as 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.

Author

N. Frerebeau

Details

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

See Also

Other grouping methods: group_extract(), group_metadata, group_split()

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_length(coda)

group_size(coda)