summary.dispRity: dispRity object summary

In TGuillerme/dispRity: Measuring Disparity

dispRity object summary

Description

Creates a summary of a dispRity object.

Usage

## S3 method for class 'dispRity'
summary(
  object,
  ...,
  quantiles = c(50, 95),
  cent.tend = median,
  recall = FALSE,
  digits
)

Arguments

object	A dispRity object.
...	Additional arguments to be passed to summary or cent.tend.
quantiles	The quantiles to display (default is quantiles = c(50, 95); is ignored if the dispRity object is not bootstrapped).
cent.tend	A function for summarising the bootstrapped disparity values (default is median).
recall	logical value specifying whether to recall the dispRity parameters input (default = FALSE).
digits	Optional, a value for digits the values in the output table (default = 2).

Details

If the dispRity object to summarise comes from a chrono.subsets using a "multiPhylo" object, the displayed number of observations (n) corresponds to the maximum number of observation at the specific time slice (some slices through some trees might have less observations).

Value

A data.frame with:

subsets	the subset names.
n	the maximum number of elements in each subset (see details).
observed	the observed disparity or the the observed central tendency (<cent_tend>) of disparity (obs.<cent_tend>).
bootstraps...	if data is bootstrapped, the bootstrapped disparity's central tendency (bs.<cent_tend>) and the quantiles of the bootstrapped disparities (or, if data is not bootstrapped but disparity is calculated as a distribution - see dispRity) - the quantiles of the observed disparity are displayed).

Author(s)

Thomas Guillerme

See Also

dispRity, plot.dispRity.

Examples

## Load the disparity data based on Beck & Lee 2014
data(disparity)

## Summarising the results
summary(disparity) # default
## Using different options
summary(disparity, quantiles = 75, cent.tend = mean, digits = 8,
     recall = TRUE)

TGuillerme/dispRity documentation built on Dec. 21, 2024, 4:05 a.m.