https://github.com/cran/ape
Tip revision: 1330e272d62c723b8073c95b066950b294f59697 authored by Emmanuel Paradis on 20 October 2012, 00:00:00 UTC
version 3.0-6
version 3.0-6
Tip revision: 1330e27
rlineage.Rd
\name{rlineage}
\alias{rlineage}
\alias{rbdtree}
\alias{drop.fossil}
\title{Tree Simulation Under the Time-Dependent Birth--Death Models}
\description{
These two functions simulate phylogenies under any time-dependent
birth--death model. \code{lineage} generates a complete tree including
the species that go extinct; \code{rbdtree} generates a tree with only
the species until present; \code{drop.fossil} is a utility function to
remove the extinct species.
}
\usage{
rlineage(birth, death, Tmax = 50, BIRTH = NULL,
DEATH = NULL, eps = 1e-6)
rbdtree(birth, death, Tmax = 50, BIRTH = NULL,
DEATH = NULL, eps = 1e-6)
drop.fossil(phy, tol = 1e-8)
}
\arguments{
\item{birth, death}{a numeric value or a (vectorized) function
specifying how speciation and extinction rates vary through time.}
\item{Tmax}{a numeric value giving the length of the simulation.}
\item{BIRTH, DEATH}{a (vectorized) function which is the primitive
of \code{birth} or \code{death}. This can be used to speed-up the
computation. By default, numerical integration is done.}
\item{eps}{a numeric value giving the time resolution of the
simulation; this may be increased (e.g., 0.001) to shorten
computation times.}
\item{phy}{an object of class \code{"phylo"}.}
\item{tol}{a numeric value giving the tolerance to consider a species
as extinct.}
}
\details{
Both functions use continuous-time algorithms described in the
references. The models are time-dependent birth--death models as
described in Kendall (1948). Speciation (birth) and extinction (death)
rates may be constant or vary through time according to an \R function
specified by the user. In the latter case, \code{BIRTH} and/or
\code{DEATH} may be used if the primitives of \code{birth} and
\code{death} are known. In these functions time is the formal argument
and must be named \code{t}.
}
\value{
An object of class \code{"phylo"}.
}
\references{
Kendall, D. G. (1948) On the generalized ``birth-and-death''
process. \emph{Annals of Mathematical Statistics}, \bold{19}, 1--15.
Paradis, E. (2011) Time-dependent speciation and extinction from
phylogenies: a least squares approach. \emph{Evolution}, \bold{65},
661--672.
}
\author{Emmanuel Paradis}
\seealso{
\code{\link{yule}}, \code{\link{yule.time}}, \code{\link{birthdeath}},
\code{\link{rtree}}, \code{\link{stree}}
}
\examples{
plot(rlineage(0.1, 0)) # Yule process with lambda = 0.1
plot(rlineage(0.1, 0.05)) # simple birth-death process
b <- function(t) 1/(1 + exp(0.2*t - 1)) # logistic
layout(matrix(0:3, 2, byrow = TRUE))
curve(b, 0, 50, xlab = "Time", ylab = "")
mu <- 0.07
segments(0, mu, 50, mu, lty = 2)
legend("topright", c(expression(lambda), expression(mu)),
lty = 1:2, bty = "n")
plot(rlineage(b, mu), show.tip.label = FALSE)
title("Simulated with 'rlineage'")
plot(rbdtree(b, mu), show.tip.label = FALSE)
title("Simulated with 'rbdtree'")
}
\keyword{datagen}