R/ClusterSignificance-package.R

In ClusterSignificance: The ClusterSignificance package provides tools to assess if class clusters in dimensionality reduced data representations have a separation different from permuted data

#' The ClusterSignificance package provides tools to assess
#' if clusters have a separation different from random or permuted
#' data.
#'
#' The ClusterSignificance package provides tools to assess
#' if clusters have a separation different from random or permuted
#' data. ClusterSignificance investigates clusters of two or more
#' groups by first, projecting all points onto a one dimensional
#' line. Cluster separations are then scored and the probability
#' of the seen separation being due to chance is evaluated using a
#' permutation method.
#'
#' \tabular{ll}{ Package: \tab ClusterSignificance\cr Type: \tab Package\cr
#' Version: \tab 1.0\cr Date: \tab 2016-02-28\cr License: \tab GPL-3\cr }
#' 
#' @name ClusterSignificance-package
#' @aliases ClusterSignificance-package ClusterSignificance
#' @docType package
#' @author Author: Jason T. Serviss, Jesper R. Gadin
#' @references Reference to published application note (work in progress)
#' @keywords package
#'
#' @import methods
#'
#' @importFrom grDevices rgb
#' @importFrom graphics lines
#' @importFrom graphics arrows
#' @importFrom utils combn
#' @importFrom grDevices colorRampPalette
#' @importFrom grDevices col2rgb
#' @importFrom grDevices n2mfrow
#' @importFrom graphics par
#' @importFrom graphics abline
#' @importFrom graphics hist
#'
NULL