man/NPRS.criterion.Rd

   1 \name{NPRS.criterion}
   2 \alias{NPRS.criterion}
   3 \title{Objective Function Employed in Nonparametric Rate Smoothing}
   4 \usage{
   5 NPRS.criterion(phy, chrono, expo = 2, minEdgeLength = 1e-06)
   6 }
   7 \arguments{
   8   \item{phy}{A non-clock-like phylogenetic tree (i.e. an object of class
   9     \code{"phylo"}), where the branch lengths are measured in
  10     substitutions.}
  11   \item{chrono}{A chronogram, i.e. a clock-like tree (i.e. an object of
  12     class \code{"phylo"}), where the branch lengths are measured in
  13     absolute time.}
  14   \item{expo}{Exponent in the objective function (default value: 2)}
  15   \item{minEdgeLength}{Minimum edge length in the phylogram (default
  16     value: 1e-06). If any branch lengths are smaller then they will be
  17     set to this value.}
  18 }
  19 \description{
  20  \code{NPRS.criterion} computes the objective function to be minimized
  21  in the NPRS (nonparametric rate smoothing) algorithm described in
  22  Sanderson (1997).
  23 }
  24 \details{
  25   Please refer to Sanderson (1997) for mathematical details. Note that
  26   is is not computationally efficient to optimize the branch lengths in
  27   a chronogram by using \code{NPRS.criterion} - please use
  28   \code{\link{chronogram}} instead.
  29 }
  30 \value{
  31   \code{NPRS.criterion} returns the value of the objective function given
  32   a phylogram and a chronogram.
  33 }
  34 \author{Gangolf Jobb (\url{http://www.treefinder.de}) and Korbinian
  35   Strimmer (\url{http://www.stat.uni-muenchen.de/~strimmer/})
  36 }
  37 \seealso{
  38   \code{\link{ratogram}}, \code{\link{chronogram}}
  39 }
  40 \references{
  41   Sanderson, M. J. (1997) A nonparametric approach to estimating
  42   divergence times in the absence of rate constancy. \emph{Molecular
  43     Biology and Evolution}, \bold{14}, 1218--1231.
  44 }
  45 \examples{
  46 # get tree
  47 data("landplants.newick") # example tree in NH format
  48 tree.landplants <- read.tree(text = landplants.newick)
  49
  50 # plot tree
  51 tree.landplants
  52 plot(tree.landplants, label.offset = 0.001)
  53
  54 # estimate chronogram
  55 chrono.plants <- chronogram(tree.landplants)
  56
  57 # plot
  58 plot(chrono.plants, label.offset = 0.001)
  59
  60 # value of NPRS function for our estimated chronogram
  61 NPRS.criterion(tree.landplants, chrono.plants)
  62 }
  63 \keyword{manip}