summary: Summary method for vegtable objects

summaryR Documentation

Summary method for vegtable objects

Description

Display summaries for vegtable objects.

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.

Usage

## S4 method for signature 'vegtable'
summary(object, units = "Kb", ...)

## S4 method for signature 'coverconvert'
summary(object, ...)

## S4 method for signature 'shaker'
summary(object, companion, authority = FALSE, ...)

## S4 method for signature 'vegtable'
show(object)

## S4 method for signature 'vegtable'
print(x, ...)

## S4 method for signature 'coverconvert'
show(object)

## S4 method for signature 'coverconvert'
print(x, ...)

## S4 method for signature 'shaker'
show(object)

## S4 method for signature 'shaker'
print(x, ...)

Arguments

object, x

Object to be summarized.

units

Units used for object size (passed to format()).

...

further arguments to be passed to or from other methods.

companion

Companion object (either a taxlist or a vegtable object.

authority

Logical value indicating whether authors should be displayed or not.

Author(s)

Miguel Alvarez kamapu78@gmail.com

Examples

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

kamapu/vegtables documentation built on Feb. 17, 2024, 8:29 a.m.