print.costMatrix: Compact display of a costmatrix

View source: R/print.costMatrix.r

print.costMatrixR Documentation

Compact display of a costmatrix

Description

Displays a compact summary of a costMatrix object.

Usage

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

Arguments

x

An object of class "costMatrix".

...

Further arguments passed to or from other methods.

Details

Displays some basic summary information on a costmatrix object.

Value

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

Author(s)

Graeme T. Lloyd graemetlloyd@gmail.com

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)


Claddis documentation built on Sept. 11, 2024, 9:18 p.m.