Summarizes the result of one or more stochastic maps.
describe.simmap(tree, ...)
# S3 method for simmap
summary(object, ...)
# S3 method for multiSimmap
summary(object, ...)
# S3 method for describe.simmap
plot(x, ...)
An object of class "describe.simmap"
with the following elements:
a matrix containing the number and types of transitions for each tree, if tree
is an object of class "multiSimmap"
.
a matrix containing the times spend in each state on each tree.
the posterior probabilities of each node being in each state, if tree
is an object of class "multiSimmap"
.
a vector containing the plot legend, if plot=TRUE
.
if class(tree)="simmap"
then the function simply returns the results of countSimmap
combined with the states at each node of the tree and a matrix containing the total and relative times spent in each state on the tree.
a single tree or a set of trees as an object of class "simmap"
or "multiSimmap"
, respectively.
object of class "simmap"
or "multiSimmap"
.
for S3 plot
method, an object of class "describe.simmap"
.
optional arguments which include: plot
, a logical value indicating whether or not to plot the posterior probabilities at nodes (default is plot=FALSE
); check.equal
, a logical value indicating whether or not to check if all trees are equal using all.equal.phylo
(default is check.equal=FALSE
); and message
, a logical indicating whether or not to print an informative message to the screen (default is message=TRUE
).
Liam Revell liam.revell@umb.edu
Revell, L. J. (2024) phytools 2.0: an updated R ecosystem for phylogenetic comparative methods (and other things). PeerJ, 12, e16505.