OUwie.dredge: Generalized Detection of shifts in OU process

View source: R/OUwie.dredge.R

OUwie.dredgeR Documentation

Generalized Detection of shifts in OU process


Allows the hypothesis free detection of shifts in the OU process. The number and location of shifts is estimated using a user-specified information criterion.


OUwie.dredge(phy, data, criterion=c("AIC", "AICc", "BIC", "mBIC"), shift.max=3, 
sigma.sq.max.k=3, alpha.max.k=3, root.age=NULL, scaleHeight=FALSE, root.station=FALSE, 
shift.point=0.5, mserr="none", algorithm=c("invert", "three.point"), 
opts = list("algorithm"="NLOPT_LN_SBPLX", "maxeval"="1000", 



a phylogenetic tree, in ape “phylo” format and with internal nodes labeled denoting the ancestral selective regimes


a dataframe containing two columns, taxon names in the first column, and species trait information in the second column.


information criterion to use for shift detection.


maximum allowed number of shifts.


maximum allowed number of sigma.sq parameters.


maximum allowed number of alpha parameters.


indicates the age of the tree. This is to be used in cases where the "tips" are not contemporary, such as in cases for fossil trees. Default is NULL meaning latest tip is modern day.


a logical indicating whether the total tree height should be scaled to 1. The default is FALSE.


a logical indicating whether the starting state, theta_0, should be estimated.


the point along a branch where a regime change is assumed to have occurred (if SIMMAP=FALSE. The default is set to 0.5, or halfway along a branch.


designates whether the standard matrix inversion ('invert') or the faster 'three-point' algorithm of Ho and Ane (2013) should be used.


designates whether a fourth column in the data matrix contains measurement error for each species value ("known"). The measurement error is assumed to be the standard error of the species mean. The default is "none".


a list of options to pass to nloptr for the optimization: useful to adjust for faster, coarser searches


This is an expanded version of the shift point model of Ho and Ane (2014). This is currently being tested, but as of now we strongly recommend using the mBIC criterion when searching for shifts.


OUwie.dredge returns an object of class OUwie.dredge. This is a list with elements:


the maximum log-likelihood.


the information criterion to use for shift detection.


the information criterion score used for shift detection.


The shift model estimated from the data.


a matrix containing the maximum likelihood estimates of alpha and sigma^2.


indicates value of the measurement error if it was estimated from the data.


a matrix containing the maximum likelihood estimates of theta.


A vector of names for the different regimes


The indices of the parameters being estimated are returned. The numbers correspond to the row in the eigvect and can useful for identifying the parameters that are causing the objective function to be at a saddlepoint (see Details)


A logical indicating whether the input phylogeny is a SIMMAP formatted tree.


The user-supplied age at the root of the tree.


Indicates whether the tree was constrained to a total height of 1.


The user-specified portion of the branch where a regime shift occurs.


Settings used for optimization routine.


The shift model dataset, which includes regime painting for each tip.


The shift model painted phylogeny.


A logical indicating whether the starting state, theta_0, was estimated


the starting values used for the parameter search.


A table containing parameter estimates and the weights for time spent in each regime for each tip.


Jeremy M. Beaulieu


Ho, L.S.T., and C. Ane. 2014. Intrinsic inference difficulties for trait evolution with Ornstein-Uhlenbeck models. Methods in Ecology and Evolution, 5: 1133-1146.

OUwie documentation built on June 15, 2022, 5:15 p.m.