Claddis (version 0.7.0)

print.costMatrix: Compact display of a costmatrix

Description

Displays a compact summary of a costMatrix object.

Usage

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

Value

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

Arguments

x

An object of class "costMatrix".

...

Further arguments passed to or from other methods.

Author

Graeme T. Lloyd

Details

Displays some basic summary information on a costmatrix object.

Examples

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

# Show print.costMatrix version:
print.costMatrix(x = example_costmatrix)