File: checkValidPhylo.Rd

package info (click to toggle)
r-cran-ape 5.7-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 3,932 kB
  • sloc: ansic: 7,626; cpp: 116; sh: 17; makefile: 2
file content (29 lines) | stat: -rw-r--r-- 682 bytes parent folder | download | duplicates (7)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
\name{checkValidPhylo}
\alias{checkValidPhylo}
\title{Check the Structure of a "phylo" Object}
\description{
  This function takes as single argument an object (phy), checks its
  elements, and prints a diagnostic. All problems are printed with a
  label: FATAL (will likely cause an error or a crash) or MODERATE (may
  cause some problems).

  This function is mainly intended for developers creating
  \code{"phylo"} objects from scratch.
}
\usage{
checkValidPhylo(phy)
}
\arguments{
  \item{phy}{an object of class \code{"phylo"}.}
}
\value{
  NULL.
}
\author{Emmanuel Paradis}
\examples{
tr <- rtree(3)
checkValidPhylo(tr)
tr$edge[1] <- 0
checkValidPhylo(tr)
}
\keyword{manip}