vegtable (version 0.1.4)

summary: Summary method for vegtable objects.

Description

Display summaries for '>vegtable objects.

Usage

# S4 method for vegtable
summary(object, units="Kb", ...)
# S4 method for coverconvert
summary(object, ...)
# S4 method for shaker
summary(object, companion, authority=FALSE, ...)

Arguments

object

Object to be summarized.

units

Units used for object size (passed to format).

companion

Companion object (either a '>taxlist or a '>vegtable object.

authority

Logical value indicating whether authors should be displayed or not.

...

further arguments to be passed to or from other methods.

Details

Those methods are implemented for objects of the classes '>vegtable, '>coverconvert and '>shaker.

The method for class 'vegtable' retrieves the metadata, the size of the object, its validity and additional statistics on the content of input object.

For objects of class '>shaker, the function 'summary' will either retrieve general statistics when 'companion' is missing, or a more detailed display when accompained by a '>taxlist or '>vegtable object.

Examples

# NOT RUN {
library(vegtable)

## Summary for 'vegtable' objects
data(Wetlands)
summary(Wetlands_veg)

## Summary for 'coverconvert' objects
data(braun_blanquet)
summary(braun_blanquet)

## Summary for 'shaker' objects (alone and with companion)
summary(Wetlands)
summary(Wetlands, Wetlands_veg)
# }