Claddis (version 0.7.0)

is.taxonGroups: Taxon groups class

Description

Functions to deal with the taxon groups class.

Usage

is.taxonGroups(x)

Value

is.taxonGroups returns either TRUE or FALSE.

Arguments

x

An object of class taxonGroups.

Author

Graeme T. Lloyd

Details

Claddis uses various classes to define specific types of data, here the use of taxon groups (to delineate different groups of taxa, e.g., clades, time bins, geographic regions etc.) ae assigned the class "taxonGroups".

is.taxonGroups checks whether an object is or is not a valid taxonGroups object.

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")
)

# Check that this is a valid taxonGroups object (will fail as class is not set):
is.taxonGroups(x = taxon_groups)

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

# Check that this is a valid taxonGroups object (will succeed as format and
# class are correct):
is.taxonGroups(x = taxon_groups)