Claddis (version 0.7.0)

print.taxonGroups: Compact display of taxon groups

Description

Displays a compact summary of a taxonGroups object.

Usage

# S3 method for taxonGroups
print(x, ...)

Value

Nothing is directly returned, instead a text summary describing a "taxonGroups" object is printed to the console.

Arguments

x

An object of class "taxonGroups".

...

Further arguments passed to or from other methods.

Author

Graeme T. Lloyd

Details

Displays some basic summary information on a taxon groups object, including number of groups and their names and partial contents.

Examples

# Create a taxon groups object:
taxon_groups <- list(
  Group_A = c("Species_1", "Species_2", "Species_3"),
  Group_B = c("Species_3", "Species_4"),
  Group_C = c("Species_5", "Species_6", "Species_7", "Species_8")
)

# Set class as taxonGroups:
class(taxon_groups) <- "taxonGroups"

# Show print.taxonGroups version of each included data sets:
print.taxonGroups(x = taxon_groups)