R/AAA_seriation-package.R

In mhahsler/seriation: Infrastructure for Ordering Objects Using Seriation

#' @keywords internal
#'
#' @section Key functions:
#' - Seriation: [seriate()], [criterion()], [get_order()], [permute()]
#' - Visualization: [pimage()], [bertinplot()], [hmap()], [dissplot()], [VAT()]
#'
#' @section Available seriation methods:
#' * [A list with the implemented seriation methods](https://mhahsler.github.io/seriation/seriation_methods.html)
#' * [A visual comparison between seriation methods](https://mhahsler.github.io/seriation/visual_comparison.html)
#' * [A list with the implemented seriation criteria](https://mhahsler.github.io/seriation/seriation_criteria.html)
#'
#' @section Quickstart guides:
#' * [How to reorder heatmaps](https://mhahsler.github.io/seriation/heatmaps.html)
#' * [How to reorder correlation matrices](https://mhahsler.github.io/seriation/correlation_matrix.html)
#' * [How to evaluate clusters using dissimilarity plots](https://mhahsler.github.io/seriation/seriation_cluster_evaluation.html)
#'
#' @references Michael Hahsler, Kurt Hornik, and Christian Buchta. Getting things in order: An introduction to the R package seriation. Journal of Statistical Software, 25(3):1--34, March 2008. \doi{10.18637/jss.v025.i03}
#'
#' @importFrom graphics plot text title
#' @importFrom ca ca
#' @importFrom stats reorder as.dist hclust runif rnorm dist order.dendrogram prcomp
#' @useDynLib seriation, .registration=TRUE
"_PACKAGE"