R/plotGraph.R

In Rgraphviz: Provides plotting capabilities for R graph objects

setMethod("plot", "graph",
  function(x, y, ..., name="",
           subGList=list(),
           attrs=list(),
           nodeAttrs=list(),
           edgeAttrs=list(),
           recipEdges=c("combined", "distinct")){
    if (!validGraph(x))
      stop("The graph to be plotted is not a valid graph structure")

    if(numNodes(x) == 0) {
        warning("graph has zero nodes; cannot layout\n")
        return(invisible(x))
    }
    
    if (missing(y)) y <- "dot"

    recipEdges <- match.arg(recipEdges)

    g <- agopen(x, name=name, layout=TRUE, layoutType=y,
                attrs=attrs, nodeAttrs=nodeAttrs,
                edgeAttrs=edgeAttrs, subGList=subGList,
                recipEdges=recipEdges)

    invisible(plot(g, y, ...))
})

setMethod("plot", "Ragraph",
  function(x, y, edgeAttrs=list(), ...,
           main=NULL, cex.main=NULL, col.main="black",
           sub=NULL, cex.sub=NULL, col.sub="black",
           drawNode=drawAgNode, xlab, ylab, mai) {

      ## layout graph
      if ( missing(y) ) y <- x@layoutType
      x <- graphLayout(x, y)

      plot.new()

      bg <- if ( x@bg != "" ) x@bg else par("bg")
      fg <- if ( x@fg != "" ) x@fg else par("fg")
      oldpars <- par(bg = bg, fg = fg)
      on.exit(par(oldpars), add = TRUE)
      
      if (missing(mai)) {
          mheight <- if(!is.null(main) && nchar(main) > 0)
              sum(strheight(main, "inches", cex.main)) + 0.3 else 0.1
          sheight <- if(!is.null(sub) && nchar(sub) > 0)
              sum(strheight(main, "inches", cex.sub)) + 0.2 else 0.1
          mai <- c(sheight, 0, mheight, 0)
      }
      oldpars <- par(mai = mai)
      on.exit(par(oldpars), add = TRUE)
      if(!is.null(sub)||!is.null(main))
          title(main, sub, cex.main = cex.main, col.main = col.main, 
                cex.sub = cex.sub, col.sub = col.sub)
      
      ur <- upRight(boundBox(x))
      bl <- botLeft(boundBox(x))
      plot.window(xlim = c(getX(bl), getX(ur)),
                  ylim = c(getY(bl), getY(ur)),
                  log = "", asp = NA, ...)
      
      if(!missing(xlab) && !missing(ylab))
          stop("Arguments 'xlab' and 'ylab' are not handled.")
      
      ## determine whether node labels fit into nodes and set "cex" accordingly
      agn <- AgNode(x)
      nodeDims <- sapply(agn, function(n) {
          c(getNodeRW(n)+getNodeLW(n), getNodeHeight(n))
      })
      strDims  <- sapply(agn, function(n) {
          s  <- labelText(txtLabel(n))
          if(length(s)==0) {
              rv <- c(strwidth(" "), strheight(" "))
          } else {
              rv <- c(strwidth(s)*1.1, strheight(s)*1.4)
          }
          return(rv)
      } )
      cex <- min(nodeDims / strDims)
      if(is.finite(cex) && cex > 0 ) {
          oldpars <- par(cex=cex)
          on.exit(par(oldpars), add = TRUE)
      }
      
      ## draw
      if (length(drawNode) == 1) {
          lapply(agn, drawNode)
      } else {
          if (length(drawNode) == length(AgNode(x))) {
              for (i in seq(along=drawNode)) {
                  drawNode[[i]](agn[[i]])
              }
          } else {
              stop(paste("Length of the drawNode parameter is ", length(drawNode),
                         ", it must be either length 1 or the number of nodes.", sep=""))
          }
      }

      ## Use the smallest node radius as a means to scale the size of
      ## the arrowheads -- in INCHES! see man page for "arrows", 
      arrowLen <- par("pin")[1] / diff(par("usr")[1:2]) * min(nodeDims) / pi
      
      ## Plot the edges
      lapply(AgEdge(x), lines, len=arrowLen, edgemode=edgemode, ...)
      
      invisible(x)
})


drawAgNode <- function(node) {
  nodeCenter <- getNodeCenter(node)
  nodeX <- getX(nodeCenter)
  nodeY <- getY(nodeCenter)

  lw <- getNodeLW(node)
  rw <- getNodeRW(node)
  rad <- (lw+rw)/2
  height <- getNodeHeight(node)
  fg <- color(node)
  style <- style(node)
  shape <- shape(node)

  ## Normal Rgraphviz defaults to circle, but DOT defaults to ellipse
  if (shape =="") shape <- "ellipse" 

  if (fg == "") fg <- "black"
  bg <- fillcolor(node)
  if (bg %in% c("", "none")) {
      if (style == "filled") bg <- "grey"
      else bg <- "transparent"
  }

  switch(shape,
         "circle"    = symbols(nodeX, nodeY, circles=rad, inches=FALSE, fg=fg, bg=bg, add=TRUE),
         "ellipse"   = ellipse(x=nodeX, y=nodeY, height=height, width=rad*2, fg=fg, bg=bg),
         "box"=,
         "rect"=,
         "rectangle" = rect(nodeX-lw, nodeY-(height/2), 
			    nodeX+rw, nodeY+(height/2), 
			    col=bg, border=fg),
         "plaintext"= { if (style == "filled")
                          rect(nodeX-lw, nodeY-(height/2),
                               nodeX+rw, nodeY+(height/2),
                               col=bg, border=FALSE) },
         stop("Unimplemented node shape: ", shape(node))
         ) ## switch

  drawTxtLabel(txtLabel(node), xLoc=nodeX, yLoc=nodeY,
               defaultFontsize=getDefaultAttrs()$node$fontsize)
}

drawTxtLabel <- function(txtLabel, xLoc, yLoc, defaultFontsize) {
  txt <- labelText(txtLabel)

  if(length(txt)>1) stop("'labelText(txtLabel)' must have length 1.")

  if(length(txt)==0) return(invisible(NULL))

  if(xor(missing(xLoc), missing(yLoc)))
    stop("'xLoc' and 'yLoc' must be either be both specified or both missing.")

  if(missing(xLoc)) {
    loc <- labelLoc(txtLabel)
    justMod <- switch(labelJust(txtLabel),
                      "l" = 0,
                      "n" = -0.5,
                      "r" = -1)
    xLoc <-  getX(loc) + (justMod * labelWidth(txtLabel))
    yLoc <-  getY(loc)
  }

  cex <- labelFontsize(txtLabel) / as.numeric(defaultFontsize)

  text(xLoc, yLoc, txt, col=labelColor(txtLabel), cex=cex)
}