Skip to contents

Describes an object.

Usage

# S4 method for CompositionMatrix
describe(x)

Arguments

x

A CompositionMatrix object.

Value

describe() is called for its side-effects. Invisibly returns x.

Author

N. Frerebeau

Examples

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

## Coerce to compositional data
coda <- as_composition(slides, sample = 1, group = 2)

## Quick description
describe(coda)
#> 25 compositions with 7 parts:
#> * 5 unique samples.
#> * 25 replicated observations.
#> * 5 groups: “A”, “B”, “C”, “D”, “E”.
#> * 0 unassigned samples.
#> 
#> Data checking:
#> * 0% of values are zero.
#> * 0 parts with no variance.
#> 
#> Missing values:
#> * 0 compositions (0%) containing missing values.
#> * 0 parts (0%) containing missing values.