man/subtreeplot.Rd

   1 \name{subtreeplot}
   2 \alias{subtreeplot}
   3 \title{Zoom on a Portion of a Phylogeny by Successive Clicks}
   4 \description{
   5   This function plots simultaneously a whole phylogenetic tree
   6   (supposedly large) and a portion of it determined by clicking on the nodes of the phylogeny. On exit, returns the last subtree visualized.
   7 }
   8 \usage{
   9 subtreeplot(x, wait=FALSE, ...)
  10 }
  11
  12 \arguments{
  13   \item{x}{an object of class \code{"phylo"}.}
  14   \item{wait}{a logical indicating whether the node beeing processed should be printed (useful for big phylogenies).}
  15   \item{\dots}{further arguments passed to \code{plot.phylo}.}
  16 }
  17 \details{
  18   This function aims at easily exploring very large trees. The main argument is
  19   a phylogenetic tree, and the second one is a logical indicating whether a waiting message should be printed while the calculation is being processed.
  20
  21   The whole tree is plotted on the left-hand side in half of the device. The
  22   subtree is plotted on the right-hand side in the other half. The user clicks on the nodes in the complete tree and the subtree corresponding to this node is ploted in the right-hand side. There is no limit for the number of clicks that can be done. On exit, the subtree on the right hand side is returned.
  23
  24   To use a subtree as the new tree in which to zoom, the user has to use the function many times. This can however be done in a single command line (see example 2).
  25 }
  26 \author{Damien de Vienne \email{damien.de-vienne@u-psud.fr}}
  27 \seealso{
  28   \code{\link{plot.phylo}}, \code{\link{drop.tip}}, \code{\link{subtrees}}
  29 }
  30 \examples{
  31 \dontrun{
  32 #example 1: simple
  33 tree1 <- rtree(50)
  34 tree2 <- subtreeplot(tree1, wait = TRUE) # on exit, tree2 will be a subtree of tree1
  35
  36 #example 2: more than one zoom
  37 tree1 <- rtree(60)
  38 tree2 <- subtreeplot(subtreeplot(subtreeplot(tree1))) # allow three succssive zooms
  39 }
  40 }
  41 \keyword{hplot}