is.stateGraph: Stategraph class

View source: R/is.stateGraph.R

is.stateGraphR Documentation

Stategraph class

Description

Functions to deal with the stategraph class.

Usage

is.stateGraph(x)

Arguments

x

An object of class stateGraph.

Details

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

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

Value

is.stateGraph returns either TRUE or FALSE.

Author(s)

Graeme T. Lloyd graemetlloyd@gmail.com

Examples


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

# Convert costmatrix to stategraph:
stategraph <- convert_costmatrix_to_stategraph(costmatrix = costmatrix)

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


graemetlloyd/Claddis documentation built on May 9, 2024, 8:07 a.m.