X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=man%2Fdrop.tip.Rd;h=4b4b60e3e496f3c8a9bdf7c2a8b985a69b9b0d52;hb=06e83c6878153f8e7999c0470263c40aad4db258;hp=f0f2aebea5db82b0f8c4403e39cb1ed9e7a8e032;hpb=f3426364b40c7c0e6aadf6ea2690716425abdfc9;p=ape.git diff --git a/man/drop.tip.Rd b/man/drop.tip.Rd index f0f2aeb..4b4b60e 100644 --- a/man/drop.tip.Rd +++ b/man/drop.tip.Rd @@ -2,10 +2,17 @@ \alias{drop.tip} \alias{extract.clade} \title{Remove Tips in a Phylogenetic Tree} +\description{ + \code{drop.tip} removes the terminal branches of a phylogenetic tree, + possibly removing the corresponding internal branches. + + \code{extract.clade} does the inverse operation: it keeps all the tips + from a given node, and deletes all the other tips. +} \usage{ drop.tip(phy, tip, trim.internal = TRUE, subtree = FALSE, - root.edge = 0) -extract.clade(phy, node, root.edge = 0) + root.edge = 0, rooted = is.rooted(phy), interactive = FALSE) +extract.clade(phy, node, root.edge = 0, interactive = FALSE) } \arguments{ \item{phy}{an object of class \code{"phylo"}.} @@ -18,14 +25,12 @@ extract.clade(phy, node, root.edge = 0) \item{root.edge}{an integer giving the number of internal branches to be used to build the new root edge. This has no effect if \code{trim.internal = FALSE}.} + \item{rooted}{a logical indicating whether the tree must be treated as + rooted or not. This allows to force the tree to be considered as + unrooted (see examples).} \item{node}{a node number or label.} -} -\description{ - \code{drop.tip} removes the terminal branches of a phylogenetic tree, - possibly removing the corresponding internal branches. - - \code{extract.clade} does the inverse operation: it keeps all the tips - from a given node, and deletes all the other tips. + \item{interactive}{if \code{TRUE} the user is asked to select the tips + or the node by clicking on the tree which must be plotted.} } \details{ The argument \code{tip} can be either character or numeric. In the @@ -55,7 +60,7 @@ extract.clade(phy, node, root.edge = 0) \value{ an object of class \code{"phylo"}. } -\author{Emmanuel Paradis \email{Emmanuel.Paradis@mpl.ird.fr}} +\author{Emmanuel Paradis} \seealso{ \code{\link{bind.tree}}, \code{\link{root}} } @@ -77,9 +82,10 @@ tip <- c( plot(drop.tip(bird.families, tip)) plot(drop.tip(bird.families, tip, trim.internal = FALSE)) data(bird.orders) -plot(drop.tip(bird.orders, 6:23, subtree = TRUE), font = 1) -plot(drop.tip(bird.orders, c(1:5, 20:23), subtree = TRUE), font = 1) - +plot(drop.tip(bird.orders, 6:23, subtree = TRUE)) +plot(drop.tip(bird.orders, c(1:5, 20:23), subtree = TRUE)) +plot(drop.tip(bird.orders, c(1:20, 23), subtree = TRUE)) +plot(drop.tip(bird.orders, c(1:20, 23), subtree = TRUE, rooted = FALSE)) ### Examples of the use of `root.edge' tr <- read.tree(text = "(A:1,(B:1,(C:1,(D:1,E:1):1):1):1):1;") drop.tip(tr, c("A", "B"), root.edge = 0) # = (C:1,(D:1,E:1):1);