Skip to content

Commit

Permalink
Document node
Browse files Browse the repository at this point in the history
  • Loading branch information
ms609 committed Apr 16, 2024
1 parent 38b4593 commit 532917c
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
5 changes: 3 additions & 2 deletions R/VisualizeQuartets.R
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,14 @@
#' named `tree1` and `tree2`, containing a matrix.
#' Each row corresponds to a split within that tree; columns correspond to:
#' \describe{
#' \item{node}{note}
#' \item{node}{The internal numbering of the node corresponding to each split,
#' as displayed by `ape::nodelabels()`}
#' \item{N\dots{}u}{The status of each quartet relative to that split,
#' as documented in [`QuartetStatus()`]}
#' \item{res}{The number of quartets resolved by that split, i.e. `s` + `d`}
#' \item{same}{The proportion of quartets resolved by that node that are
#' resolved in the same manner in the other tree; i.e. `s / s + d`}
#' }
#' }
#'
#' @examples
#' library("TreeTools", quietly = TRUE)
Expand Down
3 changes: 2 additions & 1 deletion man/VisualizeQuartets.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 532917c

Please sign in to comment.