Claddis (version 0.7.0)

is.costMatrix: Costmatrix class

Description

Functions to deal with the costmatrix class.

Usage

is.costMatrix(x)

Value

is.costMatrix returns either TRUE or FALSE.

Arguments

x

An object of class costMatrix.

Author

Graeme T. Lloyd

Details

Claddis uses various classes to define specific types of data, here the use of costmatrices (to specify the parsimony costs of transitions between character states) are assigned the class "costMatrix".

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

Examples

# Make an unordered costmatrix:
costmatrix <- make_costmatrix(
  min_state = 0,
  max_state = 2,
  character_type = "unordered"
)

# Check that this is a valid costMatrix object:
is.costMatrix(x = costmatrix)