Data Description

Describes an object.

Usage

# S4 method for class 'CompositionMatrix'
describe(x)

# S4 method for class 'GroupedComposition'
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)

## Quick description
describe(coda)
#> 25 compositions:
#> * 7 parts: “quartz”, “microcline”, “plagioclass”, “biotite”, “muscovite”, “opaques”, “nonopaques”.
#> 
#> 0 missing values:
#> * 0 observations (0%) contain missing values.
#> * 0 variables (0%) contain missing values.
#> 
#> Data checking:
#> * 0% of numeric values are zero.
#> * 0 variables with no variance.

## Group
coda <- group(coda, by = slides$slide)
describe(coda)
#> 25 compositions:
#> * 7 parts: “quartz”, “microcline”, “plagioclass”, “biotite”, “muscovite”, “opaques”, “nonopaques”.
#> * 5 groups: “A”, “B”, “C”, “D”, “E”.
#> * 0 unassigned samples.
#> 
#> 0 missing values:
#> * 0 observations (0%) contain missing values.
#> * 0 variables (0%) contain missing values.
#> 
#> Data checking:
#> * 0% of numeric values are zero.
#> * 0 variables with no variance.