pic_stat_msig: REML estimate of BM parameter

View source: R/summary-stats.R

pic_stat_msigR Documentation

REML estimate of BM parameter

Description

Calculates the mean of the squared contrasts, which is equal to the REML estimate of the BM rate parameter. Used as a test statistic to evaluate model adequacy

Usage

pic_stat_msig(unit.tree)

Arguments

unit.tree

a unit.tree object

Details

This test statistic is used to assess the ability of the model to adequate estimate the rate of evolution. On datasets simulated on a unit.tree (see simulate_char_unit), the expected value is equal to 1.

The REML estimate of sigma2 is included as a default test statistic in the function calculate_pic_stat.

The test statistic computed from a single unit.tree can be visualized with the function pic_stat_msig_plot.

Value

m.sig estimate of sigma2

See Also

calculate_pic_stat, default_pic_stat, pic_stat_msig_plot

Examples

data(finch)
phy <- finch$phy
dat <- finch$data[,"wingL"]
unit.tree <- make_unit_tree(phy, data=dat)

## Estimate sigsq from unit.tree

pic_stat_msig(unit.tree)

## Visualization

pic_stat_msig_plot(unit.tree)


mwpennell/arbutus documentation built on Oct. 6, 2022, 10 a.m.