man-roxygen/collapse-template.R

In paravian/nitro: Integration of TNT in R

#' @param <%= ifelse(isgeneric, "value", "collapse") %> an integer indicating the rule for collapsing of zero length branches. The options are:
#'   \itemize{
#'   \item \code{1}: collapse an interior branch of the maximum possible length
#'     of the branch is zero
#'   \item \code{2}: keep zero length branches if ancestor and descendent states
#'     differ
#'   \item \code{3}: collapse an interior branch if the minimum possible length
#'     of the branch is zero (the default)
#'   \item \code{4}: discard all trees that must contain a zero length branch
#'   }