File: simulateIndTree.Rd

package info (click to toggle)
r-cran-treespace 1.1.3%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 2,544 kB
  • sloc: cpp: 24; sh: 13; makefile: 2
file content (31 lines) | stat: -rw-r--r-- 1,172 bytes parent folder | download
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
30
31
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/simulateIndTree.R
\name{simulateIndTree}
\alias{simulateIndTree}
\title{Simulate randomised "individuals" tree}
\usage{
simulateIndTree(catTree, itips = 5, permuteCat = FALSE,
  permuteTips = TRUE, tipPercent = 100)
}
\arguments{
\item{catTree}{object of class phylo, the category-level tree}

\item{itips}{number of individual tips to assign per category}

\item{permuteCat}{logical specifying whether to permute the category labels on the category tree before grafting on individual tips. Defaults to FALSE.}

\item{permuteTips}{logical specifying whether to permute the individual tip labels after building the individual level tree based on the category tree. Defaults to TRUE.}

\item{tipPercent}{number specifying the percentage of tips to be permuted. Defaults to 100, ignored if permuteTips=FALSE.}
}
\description{
This function takes in a "category" tree and outputs a simulated corresponding "individuals" tree, for testing the concordance measure.
}
\examples{
tree <- simulateIndTree(rtree(3))
plot(tree)

}
\seealso{
\code{\link{treeConcordance}} \code{\link{makeCollapsedTree}}
}