R/diffusionmap-methods.r

In theislab/destiny: Creates diffusion maps

#' DiffusionMap methods
#'
#' Methods for external operations on diffusion maps
#'
#' @param x,object  A \code{\link{DiffusionMap}}
#'
#' @return The \code{DiffusionMap} object (\code{print}), or NULL (\code{show}), invisibly
#'
#' @seealso \link{DiffusionMap accession methods}, \link{Extraction methods}, \link{Coercion methods} for more
#'
#' @examples
#' data(guo)
#' dm <- DiffusionMap(guo)
#' print(dm)
#' show(dm)
#'
#' @aliases print.DiffusionMap show.DiffusionMap
#' @name DiffusionMap methods
#' @rdname DiffusionMap-methods
NULL

#' @importFrom utils str
#'
#' @rdname DiffusionMap-methods
#' @export
setMethod('print', 'DiffusionMap', function(x) {
	cat(sprintf('DiffusionMap (%s Diffusion components and %s observations)\n', length(eigenvalues(x)), nrow(eigenvectors(x))))
	cat('eigenvalues:   '); str(eigenvalues(x)) # nolint: semicolon_linter.
	cat('eigenvectors:  '); str(structure(eigenvectors(x), dimnames = NULL)) # nolint: semicolon_linter.
	cat('  ..colnames:  '); str(colnames(eigenvectors(x)), vec.len = 4) # nolint: semicolon_linter.
	cat('optimal_sigma: '); str(optimal_sigma(x)) # nolint: semicolon_linter.
	cat('distance:      '); str(distance(x)) # nolint: semicolon_linter.
	invisible(x)
})

#' @importFrom methods show
#'
#' @rdname DiffusionMap-methods
#' @export
setMethod('show', 'DiffusionMap', function(object) {
	print(object)
	invisible()
})