R/Helper-functions.R

In Radviz: Project Multidimensional Data in 2D Space

#' Radviz Object Summary, head, print, dim and springs Methods
#' 
#' Provides a summary for Radviz objects
#' 
#' @method summary radviz
#' 
#' @param x an object of class Radviz, as returned by \code{\link{do.radviz}}
#' @param object an object of class Radviz, as returned by \code{\link{do.radviz}}
#' @param n the number of lines from each slots in the Radviz object to display (defaults to 6)
#' @param ...	further arguments to be passed to or from other methods (not implemented)
#' 
#' @details \code{dim} returns the number of points and the number of dimensions 
#' used for the projection.
#' \code{print} returns invisibly the data, including the projected coordinates
#' 
#' @example examples/example-do.radviz.R
#' @examples
#' 
#' summary(rv)
#' head(rv)
#' dim(rv)
#' print(rv)
#' 
#' @author Yann Abraham
#' @importFrom utils head
#' @export
summary.radviz <- function(object,...,n=6) {
  cat('A Radviz object with',nrow(object$proj$data),'objects and',length(springs(object)),'dimensions\n')
  print(head(object$proj$data,n))
  if(any(object$proj$data$rvalid)) {
    cat(sum(object$proj$data$rvalid),'point(s) could not be projected\n')
  }
  das <- rownames(springs(object))
  if(length(das)>n) {
    das <- das[seq(1,n)]
    das <- c(das,'...')
  }
  cat('Dimensional Anchors are',das,'\n')
}

#' @rdname summary.radviz
#' @method head radviz
#' @export
head.radviz <- function(x,n=6,...) {
  print(head(x$proj$data,n=n))
}

#' @rdname summary.radviz
#' @method dim radviz
#' @export
dim.radviz <- function(x) {
  return(c(nrow(x$proj$data),
           length(springs(x))))
}

#' @rdname summary.radviz
#' @method print radviz
#' @export
print.radviz <- function(x,...) {
  plot.radviz(x)
  return(invisible(x$proj$data))
}

#' @rdname summary.radviz
#' @export
springs <- function(x) {
  return(x$springs)
}