man-roxygen/plot_clust.R

In rickhelmus/patRoon: Workflows for Mass-Spectrometry Based Non-Target Analysis

#' @param pal Colour palette to be used from \pkg{\link{RColorBrewer}}.
#' @param colourBranches Whether branches from cut clusters (and their labels)
#'   should be coloured. Might be slow with large numbers of clusters, hence,
#'   the default is only \code{TRUE} when this is not the case.
#' @param showLegend If \code{TRUE} and \code{colourBranches} is also
#'   \code{TRUE} then a legend will be shown which outlines cluster numbers and
#'   their colours. By default \code{TRUE} for small amount of clusters to avoid
#'   overflowing the plot.
#' <%=if (!exists("withoutDots") || !withoutDots) "@param \\dots Any arguments directly given to \\code{\\link{plot.dendrogram}}." else "" %>