R/mvBM.getRate.R

In JeroenSmaers/evomap: Evomap

#' Lineage-specific rate estimation using multiple variance Brownian motion
#'
#' Computes lineage-specific rates using mvBM 
#' @param tree an object of class "phylo".
#' @param tree_mvBM an object of class "phylo". The rescaled tree from an mvBM procedure.
#' @param branches vector listing the branch numbers ('edge' numbers) for which the mvBM rate should be computed
#' @param sigma2Distr the MCMC distribution of sigma2 from an MCMC mvBM procedure
#' @return mvBM rate estimate
#' @references Smaers, Mongle & Kandler (2016) A multiple variance Brownian motion framework for estimating variable rates and inferring ancestral states. Biological Journal of the Linnean Society. 118 (1): 78-94.
#' @examples see https://smaerslab.com/software/ 

#' @export
    mvBM.getRate<-function(tree,tree_mvBM,branches,sigma2Distr){
    rateDistr<-sigma2Distr*(sum(tree_mvBM$edge.length[branches])/sum(tree$edge.length[branches]))
    return(mean(rateDistr))
    }