R/xGraphML.r
In hfang-bristol/XGR: Exploring Genomic Relations for Enhanced Interpretation Through Enrichment, Similarity, Network and Annotation Analysis
Defines functions
xGraphML
Documented in
xGraphML
#' Function to generate a graphml file from a graph object of class "igraph"
#'
#' \code{xGraphML} is supposed to generate a graphml file from a graph object of class "igraph".
#'
#' @param g an object of class "igraph"
#' @param node.label either a vector labelling nodes or a character specifying which node attribute used for the labelling. If NULL (by default), no node labelling. If provided as a vector, a node with 'NA' will be not labelled
#' @param label.wrap.width a positive integer specifying wrap width of name
#' @param node.label.size the node label size
#' @param node.label.color the node label color
#' @param node.tooltip either a vector used for node tooltips or a character specifying which node attribute used for the tooltips. If NULL (by default), node attribute 'name' will be used node lab
#' @param node.link either a vector used for node link or a character specifying which node attribute used for the link
#' @param node.xcoord a vector specifying x coordinates. If NULL, it will be created using igraph::layout_with_kk
#' @param node.ycoord a vector specifying y coordinates. If NULL, it will be created using igraph::layout_with_kk
#' @param node.color.na the color for nodes with NA. By default, it is '#dddddd'
#' @param node.color a character specifying which node attribute used for node coloring. If NULL (by default), it is '#BFFFBF'
#' @param colormap short name for the colormap. It can be one of "jet" (jet colormap), "bwr" (blue-white-red colormap), "gbr" (green-black-red colormap), "wyr" (white-yellow-red colormap), "br" (black-red colormap), "yr" (yellow-red colormap), "wb" (white-black colormap), "rainbow" (rainbow colormap, that is, red-yellow-green-cyan-blue-magenta), and "ggplot2" (emulating ggplot2 default color palette). Alternatively, any hyphen-separated HTML color names, e.g. "lightyellow-orange" (by default), "blue-black-yellow", "royalblue-white-sandybrown", "darkgreen-white-darkviolet". A list of standard color names can be found in \url{http://html-color-codes.info/color-names}
#' @param ncolors the number of colors specified over the colormap
#' @param nlegend the number of colors specified in the legend. By default, it is 11
#' @param legend.label.size the legend label size. By default, it is 10
#' @param legend.interval the interval between legends. By default, it is 0.05
#' @param zlim the minimum and maximum z/patttern values for which colors should be plotted, defaulting to the range of the finite values of z. Each of the given colors will be used to color an equispaced interval of this range. The midpoints of the intervals cover the range, so that values just outside the range will be plotted
#' @param node.size either a vector specifying node size or a character specifying which node attribute used for the node size. If NULL (by default), it will be 30
#' @param node.coord.scale the node coord (-1,1) subjected to be rescaled. By default, it is 300
#' @param edge.color a character specifying the edge colors. By default, it is #00000033
#' @param edge.width the edge width. By default, it is 1
#' @param filename the without-extension part of the name of the output file. By default, it is 'xGraphML'
#' @param verbose logical to indicate whether the messages will be displayed in the screen. By default, it sets to true for display
#' @return
#' invisible (a string storing graphml-formatted content). If the filename is not NULL, a graphml-formatted file is also output.
#' @note none
#' @export
#' @seealso \code{\link{xGraphML}}
#' @include xGraphML.r
#' @examples
#' \dontrun{
#' # Load the library
#' library(XGR)
#' RData.location <- "http://galahad.well.ox.ac.uk/bigdata/"
#'
#' # 1) load REACTOME
#' # 1a) restricted to Immune System ('R-HSA-168256') or Signal Transduction ('R-HSA-162582')
#' g <- xRDataLoader(RData.customised='ig.REACTOME', RData.location=RData.location)
#' neighs.out <- igraph::neighborhood(g, order=vcount(g), nodes="R-HSA-168256", mode="out")
#' nodeInduced <- V(g)[unique(unlist(neighs.out))]$name
#' ig <- igraph::induced.subgraph(g, vids=nodeInduced)
#' # visualise the graph with vertices being color-coded by the pattern
#' V(ig)$pattern <- runif(vcount(ig))
#' xGraphML(g=ig, node.label="name", node.color="pattern", colormap="wyr", node.size=10, node.label.size=6)
#'
#' # 1b) restricted to Signal Transduction ('R-HSA-162582')
#' g <- xRDataLoader(RData.customised='ig.REACTOME', RData.location=RData.location)
#' neighs.out <- igraph::neighborhood(g, order=vcount(g), nodes="R-HSA-162582", mode="out")
#' nodeInduced <- V(g)[unique(unlist(neighs.out))]$name
#' ig <- igraph::induced.subgraph(g, vids=nodeInduced)
#' # visualise the graph with vertices being color-coded by the pattern
#' V(ig)$pattern <- runif(vcount(ig))
#' xGraphML(g=ig, node.label="name", node.color="pattern", colormap="wyr", node.size=8, node.label.size=4)
#'
#' ###########################
#' # visualise gene network
#' glayout <- igraph::layout_with_kk(ig)
#' V(ig)$xcoord <- glayout[,1]
#' V(ig)$ycoord <- glayout[,2]
#' V(ig)$node.link <- paste0("http://www.genecards.org/cgi-bin/carddisp.pl?gene=", V(ig)$name)
#' xGraphML(g=ig, node.label="name", node.tooltip="description", node.xcoord="xcoord", node.ycoord="ycoord", node.color="pattern", colormap="grey-orange-darkred", node.link="node.link", nlegend=11, node.size=30, node.coord.scale=300)
#' }
xGraphML <- function(g, node.label=NULL, label.wrap.width=NULL, node.label.size=12, node.label.color='#000000', node.tooltip=NULL, node.link=NULL, node.xcoord="xcoord", node.ycoord="ycoord", node.color.na='#dddddd', node.color=NULL, colormap='grey-orange-darkred', ncolors=64, nlegend=11, legend.label.size=10, legend.interval=0.05, zlim=NULL, node.size=30, node.coord.scale=300, edge.color="#00000033", edge.width=1, filename='xGraphML', verbose=T)
{
if (!is(g,"igraph")){
stop("The function must apply to either 'igraph' or 'graphNEL' object.\n")
}else{
ig <- g
}
######################################################################################
######################################################################################
## node.color (by default, "#BFFFBF")
df_legends <- NULL
if (!is.null(node.color)){
pattern <- igraph::vertex_attr(ig, node.color)
if(!is.null(pattern)){
pattern <- as.numeric(pattern)
pattern_nona <- pattern[!is.na(pattern)]
pattern_nona <- as.numeric(pattern_nona)
if(is.null(zlim)){
vmin <- floor(stats::quantile(pattern_nona, 0.05))
vmax <- ceiling(stats::quantile(pattern_nona, 0.95))
if(vmin < 0 & vmax > 0){
vsym <- abs(min(vmin, vmax))
vmin <- -1*vsym
vmax <- vsym
}
zlim <- c(vmin,vmax)
}
## A function to map a vector to colors
vec2color <- function(vec, colormap=colormap, ncolors=ncolors, zlim=zlim){
palette.name <- xColormap(colormap=colormap)
colors <- palette.name(ncolors)
scale <- length(colors)/(max(zlim)-min(zlim))
sapply(1:length(vec), function(x){
if(is.na(vec[x])){
'#dddddd'
}else{
ind <- floor(1+(vec[x]-min(zlim))*scale)
colors[max(1,min(ncolors,ind))]
}
})
}
node.color <- vec2color(pattern, colormap=colormap, ncolors=ncolors, zlim=zlim)
#############
## df_legends
colors <- xColormap(colormap=colormap)(ncolors)
legend_colors <- colors[round(seq(1,ncolors,length.out=nlegend))]
df_legends <- data.frame(name=paste0('l',1:nlegend), colors=legend_colors, labels=signif(seq(min(zlim),max(zlim),length.out=nlegend),digits=2), x=rep(-1.1,nlegend), y=1-cumsum(c(0,rep(legend.interval,nlegend-1))), stringsAsFactors=FALSE)
#############
}else{
warning("The input 'pattern' is ignored. Please check the help for enabling your input")
node.color <- rep("#BFFFBF", vcount(ig))
}
}else{
node.color <- rep("#BFFFBF", vcount(ig))
}
######################################################################################
######################################################################################
#############
## head
#############
output.head <- '<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<graphml xmlns="http://graphml.graphdrawing.org/xmlns" xmlns:java="http://www.yworks.com/xml/yfiles-common/1.0/java" xmlns:sys="http://www.yworks.com/xml/yfiles-common/markup/primitives/2.0" xmlns:x="http://www.yworks.com/xml/yfiles-common/markup/2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:y="http://www.yworks.com/xml/graphml" xmlns:yed="http://www.yworks.com/xml/yed/3" xsi:schemaLocation="http://graphml.graphdrawing.org/xmlns http://www.yworks.com/xml/schema/graphml/1.1/ygraphml.xsd">
<!--Created by yEd 3.17-->
<key for="node" id="d1" attr.name="url" attr.type="string"/>
<key for="node" id="d2" attr.name="description" attr.type="string"/>
<key for="node" id="d3" yfiles.type="nodegraphics"/>
<key for="edge" id="d4" attr.name="description" attr.type="string"/>
<key for="edge" id="d5" yfiles.type="edgegraphics"/>
<key for="graphml" id="d6" yfiles.type="resources"/>
<graph edgedefault="directed" id="G">';
#############
## nodes
#############
nnode <- igraph::vcount(ig)
## node.label (by default, NULL)
if(length(node.label)!=nnode){
if(!is.null(node.label)){
node.label <- igraph::vertex_attr(ig, node.label)
}
if(is.null(node.label)){
#node.label <- igraph::vertex_attr(ig, 'name')
node.label <- rep(NA, nnode)
}
}
node.label <- unlist(lapply(node.label, function(x) gsub('/','-',x)))
node.label <- unlist(lapply(node.label, function(x) gsub('&','-',x)))
## text wrap
if(!is.null(label.wrap.width)){
width <- as.integer(label.wrap.width)
res_list <- lapply(node.label, function(x){
if(!is.na(x)){
x <- gsub('_', ' ', x)
y <- strwrap(x, width=width)
if(length(y)==2){
paste(y, collapse='\n')
}else if(length(y)>2){
#paste0(y[1], '...')
#paste0(paste(y[1:2],collapse='\n'),'...' )
paste(y,collapse='\n')
}else{
y
}
}else{
x
}
})
node.label <- unlist(res_list)
}
## node.tooltip (by default, the 'name' node attribute)
if(length(node.tooltip)!=nnode){
if(!is.null(node.tooltip)){
node.tooltip <- igraph::vertex_attr(ig, node.tooltip)
}
if(is.null(node.tooltip)){
node.tooltip <- igraph::vertex_attr(ig, 'name')
}
}
node.tooltip <- unlist(lapply(node.tooltip, function(x) gsub('/','-',x)))
node.tooltip <- unlist(lapply(node.tooltip, function(x) gsub('&','-',x)))
## node.link (by default, the 'name' node attribute)
if(length(node.link)!=nnode){
if(!is.null(node.link)){
node.link <- igraph::vertex_attr(ig, node.link)
}
if(is.null(node.link)){
node.link <- igraph::vertex_attr(ig, 'name')
}
}
## node.size (by default, 30)
if(length(node.size)!=nnode){
if(!is.null(node.size)){
tmp.node.size <- igraph::vertex_attr(ig, node.size)
#tmp.node.size <- 5 + 24 * (tmp.node.size - min(tmp.node.size)) / (max(tmp.node.size) - min(tmp.node.size))
}else{
tmp.node.size <- rep(30, nnode)
}
if(is.null(tmp.node.size)){
node.size <- rep(node.size, nnode)
}else{
node.size <- tmp.node.size
}
}
## artificially create 'name'
V(ig)$label <- V(ig)$name
V(ig)$name <- paste0('n', 1:vcount(ig))
## layout
## node.xcoord (by default, NULL)
if(length(node.xcoord)!=nnode | length(node.ycoord)!=nnode){
if(!is.null(node.xcoord)){
node.xcoord <- igraph::vertex_attr(ig, node.xcoord)
}
if(!is.null(node.ycoord)){
node.ycoord <- igraph::vertex_attr(ig, node.ycoord)
}
if(is.null(node.xcoord) | is.null(node.ycoord)){
## layout
#glayout <- igraph::layout_with_kk(ig)
glayout <- igraph::layout_as_tree(ig,root=dnet::dDAGroot(ig),circular=TRUE,flip.y=TRUE)
glayout <- glayout[,c(2:1)]
node.xcoord <- glayout[,1]
node.ycoord <- glayout[,2]
}
}
## scale into [-1,1]
if(max(node.xcoord) != min(node.xcoord)){
node.xcoord <- (node.xcoord - min(node.xcoord)) / (max(node.xcoord) - min(node.xcoord)) * 2 - 1
}
if(max(node.ycoord) != min(node.ycoord)){
node.ycoord <- (node.ycoord - min(node.ycoord)) / (max(node.ycoord) - min(node.ycoord)) * 2 - 1
}
# reverse node.ycoord
node.ycoord <- -node.ycoord
# enlarge coordinates
node.xcoord <- node.xcoord*node.coord.scale
node.ycoord <- node.ycoord*node.coord.scale
## do loop
df_nodes <- igraph::get.data.frame(ig, what="vertices")
df_nodes$node.label <- node.label
df_nodes$node.tooltip <- node.tooltip
df_nodes$node.link <- node.link
#df_nodes$node.color <- node.color
df_nodes$node.color <- paste0(node.color, 'cc')
df_nodes$node.size <- node.size
### sort: NA comes last
#df_nodes <- df_nodes[with(df_nodes,order(node.label)), ]
###
ls_nodes <- lapply(1:nrow(df_nodes), function(i){
k <- 0
vec <- vector()
k <- k+1
vec[k] <- paste0('<node id="', df_nodes$name[i], '">')
#######
if(!is.null(node.link)){
k <- k+1
#vec[k] <- paste0('<data key="d1"><![CDATA[', node.link, df_nodes$node.label[i], ']]></data>')
vec[k] <- paste0('<data key="d1"><![CDATA[', df_nodes$node.link[i],']]></data>')
}
#######
k <- k+1
vec[k] <- paste0('<data key="d2"><![CDATA[', df_nodes$node.tooltip[i], ']]></data>')
k <- k+1
vec[k] <- paste0('<data key="d3">')
k <- k+1
vec[k] <- paste0('<y:ShapeNode>')
k <- k+1
#vec[k] <- paste0('<y:Geometry height="', df_nodes$node.size[i], '" width="', df_nodes$node.size[i] ,'" x="0" y="0"/>')
#vec[k] <- paste0('<y:Geometry height="1" width="2" x="', glayout[i,1], '" y="', glayout[i,2], '"/>')
vec[k] <- paste0('<y:Geometry height="', df_nodes$node.size[i], '" width="', df_nodes$node.size[i] ,'" x="', node.xcoord[i], '" y="', node.ycoord[i], '"/>')
k <- k+1
vec[k] <- paste0('<y:Fill color="', df_nodes$node.color[i], '" transparent="false"/>')
k <- k+1
vec[k] <- paste0('<y:BorderStyle color="#dddddd" raised="false" type="line" width="1"/>')
########
k <- k+1
if(!is.na(df_nodes$node.label[i])){
vec[k] <- paste0('<y:NodeLabel alignment="center" autoSizePolicy="content" borderDistance="0.0" fontFamily="Arial" fontSize="',node.label.size,'" fontStyle="italic" hasBackgroundColor="false" hasLineColor="false" height="30" horizontalTextPosition="center" iconTextGap="4" modelName="sides" modelPosition="n" textColor="',node.label.color,'" verticalTextPosition="bottom" visible="true" width="30" x="0" y="0">', df_nodes$node.label[i], '</y:NodeLabel>')
}else{
vec[k] <- paste0('<y:NodeLabel alignment="center" autoSizePolicy="content" borderDistance="0.0" fontFamily="Arial" fontSize="',node.label.size,'" fontStyle="italic" hasBackgroundColor="false" hasLineColor="false" height="30" horizontalTextPosition="center" iconTextGap="4" modelName="sides" modelPosition="n" textColor="',node.label.color,'" verticalTextPosition="bottom" visible="false" width="30" x="0" y="0">', df_nodes$node.tooltip[i], '</y:NodeLabel>')
}
########
k <- k+1
vec[k] <- paste0('<y:Shape type="ellipse"/>')
k <- k+1
vec[k] <- paste0('</y:ShapeNode>')
k <- k+1
vec[k] <- paste0('</data>')
k <- k+1
vec[k] <- paste0('</node>')
paste(vec, collapse='\n')
})
vec_nodes <- unlist(ls_nodes)
output.nodes <- paste(vec_nodes, collapse='\n')
if(!is.null(df_legends)){
############
## legends
#############
ls_legends <- lapply(1:nrow(df_legends), function(i){
k <- 0
vec <- vector()
k <- k+1
vec[k] <- paste0('<node id="', df_legends$name[i], '">')
k <- k+1
vec[k] <- paste0('<data key="d2"><![CDATA[', df_legends$labels[i], ']]></data>')
k <- k+1
vec[k] <- paste0('<data key="d3">')
k <- k+1
vec[k] <- paste0('<y:ShapeNode>')
k <- k+1
vec[k] <- paste0('<y:Geometry height="',legend.interval*node.coord.scale,'" width="',legend.interval*node.coord.scale,'" x="', df_legends$x[i]*node.coord.scale, '" y="', df_legends$y[i]*node.coord.scale, '"/>')
k <- k+1
vec[k] <- paste0('<y:Fill color="', df_legends$colors[i], '" transparent="false"/>')
k <- k+1
vec[k] <- paste0('<y:BorderStyle color="#dddddd" raised="false" type="line" width="1"/>')
########
k <- k+1
vec[k] <- paste0('<y:NodeLabel alignment="center" autoSizePolicy="content" borderDistance="0.0" fontFamily="Arial" fontSize="',legend.label.size,'" fontStyle="plain" hasBackgroundColor="false" hasLineColor="false" height="30" horizontalTextPosition="center" iconTextGap="4" modelName="sides" modelPosition="w" textColor="#000000" verticalTextPosition="bottom" visible="true" width="30" x="0" y="0">', df_legends$labels[i], '</y:NodeLabel>')
########
k <- k+1
vec[k] <- paste0('<y:Shape type="ellipse"/>')
k <- k+1
vec[k] <- paste0('</y:ShapeNode>')
k <- k+1
vec[k] <- paste0('</data>')
k <- k+1
vec[k] <- paste0('</node>')
paste(vec, collapse='\n')
})
vec_legends <- unlist(ls_legends)
output.legends <- paste(vec_legends, collapse='\n')
}else{
output.legends <- NULL
}
############
## edges
#############
df_edges <- igraph::get.data.frame(ig, what="edges")
ls_edges <- lapply(1:nrow(df_edges), function(i){
source <- df_edges$from[i]
target <- df_edges$to[i]
k <- 0
vec <- vector()
k <- k+1
vec[k] <- paste0('<edge id="', 'e', i, '" source="', source, '" target="', target, '">')
k <- k+1
vec[k] <- paste0('<data key="d5">')
k <- k+1
vec[k] <- paste0('<y:GenericEdge configuration="DEFAULT">')
if(0){
k <- k+1
vec[k] <- paste0('<y:Path sx="0" sy="0" tx="0" ty="0"/>')
}
k <- k+1
vec[k] <- paste0('<y:LineStyle color="',edge.color,'" type="line" width="',edge.width,'"/>')
k <- k+1
if(igraph::is_directed(ig)){
vec[k] <- paste0('<y:Arrows source="none" target="standard"/>')
}else{
vec[k] <- paste0('<y:Arrows source="none" target="none"/>')
}
k <- k+1
vec[k] <- paste0('</y:GenericEdge>')
k <- k+1
vec[k] <- paste0('</data>')
k <- k+1
vec[k] <- paste0('</edge>')
paste(vec, collapse='\n')
})
vec_edges <- unlist(ls_edges)
output.edges <- paste(vec_edges, collapse='\n')
#############
## tail
#############
output.tail <- '</graph>
<data key="d6">
<y:Resources/>
</data>
</graphml>'
if(is.null(output.legends)){
output <- paste0(output.head, '\n', output.nodes, '\n', output.edges, '\n', output.tail, '\n')
}else{
output <- paste0(output.head, '\n', output.nodes, '\n', output.legends, '\n', output.edges, '\n', output.tail, '\n')
}
if(!is.null(filename)){
############################
filename <- gsub('.graphml$', '', filename)
outputfile <- paste0(filename, ".graphml")
fileConn <- base::file(outputfile)
base::writeLines(output, fileConn)
base::close(fileConn)
if(verbose){
message(sprintf("Congratulations! A file '%s' (in the directory %s) has been created!", outputfile, getwd()), appendLF=T)
}
############################
}
invisible(output)
}
hfang-bristol/XGR documentation built on Feb. 4, 2023, 7:05 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Defines functions xGraphML
Documented in xGraphML
#' Function to generate a graphml file from a graph object of class "igraph"
#'
#' \code{xGraphML} is supposed to generate a graphml file from a graph object of class "igraph".
#'
#' @param g an object of class "igraph"
#' @param node.label either a vector labelling nodes or a character specifying which node attribute used for the labelling. If NULL (by default), no node labelling. If provided as a vector, a node with 'NA' will be not labelled
#' @param label.wrap.width a positive integer specifying wrap width of name
#' @param node.label.size the node label size
#' @param node.label.color the node label color
#' @param node.tooltip either a vector used for node tooltips or a character specifying which node attribute used for the tooltips. If NULL (by default), node attribute 'name' will be used node lab
#' @param node.link either a vector used for node link or a character specifying which node attribute used for the link
#' @param node.xcoord a vector specifying x coordinates. If NULL, it will be created using igraph::layout_with_kk
#' @param node.ycoord a vector specifying y coordinates. If NULL, it will be created using igraph::layout_with_kk
#' @param node.color.na the color for nodes with NA. By default, it is '#dddddd'
#' @param node.color a character specifying which node attribute used for node coloring. If NULL (by default), it is '#BFFFBF'
#' @param colormap short name for the colormap. It can be one of "jet" (jet colormap), "bwr" (blue-white-red colormap), "gbr" (green-black-red colormap), "wyr" (white-yellow-red colormap), "br" (black-red colormap), "yr" (yellow-red colormap), "wb" (white-black colormap), "rainbow" (rainbow colormap, that is, red-yellow-green-cyan-blue-magenta), and "ggplot2" (emulating ggplot2 default color palette). Alternatively, any hyphen-separated HTML color names, e.g. "lightyellow-orange" (by default), "blue-black-yellow", "royalblue-white-sandybrown", "darkgreen-white-darkviolet". A list of standard color names can be found in \url{http://html-color-codes.info/color-names}
#' @param ncolors the number of colors specified over the colormap
#' @param nlegend the number of colors specified in the legend. By default, it is 11
#' @param legend.label.size the legend label size. By default, it is 10
#' @param legend.interval the interval between legends. By default, it is 0.05
#' @param zlim the minimum and maximum z/patttern values for which colors should be plotted, defaulting to the range of the finite values of z. Each of the given colors will be used to color an equispaced interval of this range. The midpoints of the intervals cover the range, so that values just outside the range will be plotted
#' @param node.size either a vector specifying node size or a character specifying which node attribute used for the node size. If NULL (by default), it will be 30
#' @param node.coord.scale the node coord (-1,1) subjected to be rescaled. By default, it is 300
#' @param edge.color a character specifying the edge colors. By default, it is #00000033
#' @param edge.width the edge width. By default, it is 1
#' @param filename the without-extension part of the name of the output file. By default, it is 'xGraphML'
#' @param verbose logical to indicate whether the messages will be displayed in the screen. By default, it sets to true for display
#' @return
#' invisible (a string storing graphml-formatted content). If the filename is not NULL, a graphml-formatted file is also output.
#' @note none
#' @export
#' @seealso \code{\link{xGraphML}}
#' @include xGraphML.r
#' @examples
#' \dontrun{
#' # Load the library
#' library(XGR)
#' RData.location <- "http://galahad.well.ox.ac.uk/bigdata/"
#'
#' # 1) load REACTOME
#' # 1a) restricted to Immune System ('R-HSA-168256') or Signal Transduction ('R-HSA-162582')
#' g <- xRDataLoader(RData.customised='ig.REACTOME', RData.location=RData.location)
#' neighs.out <- igraph::neighborhood(g, order=vcount(g), nodes="R-HSA-168256", mode="out")
#' nodeInduced <- V(g)[unique(unlist(neighs.out))]$name
#' ig <- igraph::induced.subgraph(g, vids=nodeInduced)
#' # visualise the graph with vertices being color-coded by the pattern
#' V(ig)$pattern <- runif(vcount(ig))
#' xGraphML(g=ig, node.label="name", node.color="pattern", colormap="wyr", node.size=10, node.label.size=6)
#'
#' # 1b) restricted to Signal Transduction ('R-HSA-162582')
#' g <- xRDataLoader(RData.customised='ig.REACTOME', RData.location=RData.location)
#' neighs.out <- igraph::neighborhood(g, order=vcount(g), nodes="R-HSA-162582", mode="out")
#' nodeInduced <- V(g)[unique(unlist(neighs.out))]$name
#' ig <- igraph::induced.subgraph(g, vids=nodeInduced)
#' # visualise the graph with vertices being color-coded by the pattern
#' V(ig)$pattern <- runif(vcount(ig))
#' xGraphML(g=ig, node.label="name", node.color="pattern", colormap="wyr", node.size=8, node.label.size=4)
#'
#' ###########################
#' # visualise gene network
#' glayout <- igraph::layout_with_kk(ig)
#' V(ig)$xcoord <- glayout[,1]
#' V(ig)$ycoord <- glayout[,2]
#' V(ig)$node.link <- paste0("http://www.genecards.org/cgi-bin/carddisp.pl?gene=", V(ig)$name)
#' xGraphML(g=ig, node.label="name", node.tooltip="description", node.xcoord="xcoord", node.ycoord="ycoord", node.color="pattern", colormap="grey-orange-darkred", node.link="node.link", nlegend=11, node.size=30, node.coord.scale=300)
#' }
xGraphML <- function(g, node.label=NULL, label.wrap.width=NULL, node.label.size=12, node.label.color='#000000', node.tooltip=NULL, node.link=NULL, node.xcoord="xcoord", node.ycoord="ycoord", node.color.na='#dddddd', node.color=NULL, colormap='grey-orange-darkred', ncolors=64, nlegend=11, legend.label.size=10, legend.interval=0.05, zlim=NULL, node.size=30, node.coord.scale=300, edge.color="#00000033", edge.width=1, filename='xGraphML', verbose=T)
{
if (!is(g,"igraph")){
stop("The function must apply to either 'igraph' or 'graphNEL' object.\n")
}else{
ig <- g
}
######################################################################################
######################################################################################
## node.color (by default, "#BFFFBF")
df_legends <- NULL
if (!is.null(node.color)){
pattern <- igraph::vertex_attr(ig, node.color)
if(!is.null(pattern)){
pattern <- as.numeric(pattern)
pattern_nona <- pattern[!is.na(pattern)]
pattern_nona <- as.numeric(pattern_nona)
if(is.null(zlim)){
vmin <- floor(stats::quantile(pattern_nona, 0.05))
vmax <- ceiling(stats::quantile(pattern_nona, 0.95))
if(vmin < 0 & vmax > 0){
vsym <- abs(min(vmin, vmax))
vmin <- -1*vsym
vmax <- vsym
}
zlim <- c(vmin,vmax)
}
## A function to map a vector to colors
vec2color <- function(vec, colormap=colormap, ncolors=ncolors, zlim=zlim){
palette.name <- xColormap(colormap=colormap)
colors <- palette.name(ncolors)
scale <- length(colors)/(max(zlim)-min(zlim))
sapply(1:length(vec), function(x){
if(is.na(vec[x])){
'#dddddd'
}else{
ind <- floor(1+(vec[x]-min(zlim))*scale)
colors[max(1,min(ncolors,ind))]
}
})
}
node.color <- vec2color(pattern, colormap=colormap, ncolors=ncolors, zlim=zlim)
#############
## df_legends
colors <- xColormap(colormap=colormap)(ncolors)
legend_colors <- colors[round(seq(1,ncolors,length.out=nlegend))]
df_legends <- data.frame(name=paste0('l',1:nlegend), colors=legend_colors, labels=signif(seq(min(zlim),max(zlim),length.out=nlegend),digits=2), x=rep(-1.1,nlegend), y=1-cumsum(c(0,rep(legend.interval,nlegend-1))), stringsAsFactors=FALSE)
#############
}else{
warning("The input 'pattern' is ignored. Please check the help for enabling your input")
node.color <- rep("#BFFFBF", vcount(ig))
}
}else{
node.color <- rep("#BFFFBF", vcount(ig))
}
######################################################################################
######################################################################################
#############
## head
#############
output.head <- '<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<graphml xmlns="http://graphml.graphdrawing.org/xmlns" xmlns:java="http://www.yworks.com/xml/yfiles-common/1.0/java" xmlns:sys="http://www.yworks.com/xml/yfiles-common/markup/primitives/2.0" xmlns:x="http://www.yworks.com/xml/yfiles-common/markup/2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:y="http://www.yworks.com/xml/graphml" xmlns:yed="http://www.yworks.com/xml/yed/3" xsi:schemaLocation="http://graphml.graphdrawing.org/xmlns http://www.yworks.com/xml/schema/graphml/1.1/ygraphml.xsd">
<!--Created by yEd 3.17-->
<key for="node" id="d1" attr.name="url" attr.type="string"/>
<key for="node" id="d2" attr.name="description" attr.type="string"/>
<key for="node" id="d3" yfiles.type="nodegraphics"/>
<key for="edge" id="d4" attr.name="description" attr.type="string"/>
<key for="edge" id="d5" yfiles.type="edgegraphics"/>
<key for="graphml" id="d6" yfiles.type="resources"/>
<graph edgedefault="directed" id="G">';
#############
## nodes
#############
nnode <- igraph::vcount(ig)
## node.label (by default, NULL)
if(length(node.label)!=nnode){
if(!is.null(node.label)){
node.label <- igraph::vertex_attr(ig, node.label)
}
if(is.null(node.label)){
#node.label <- igraph::vertex_attr(ig, 'name')
node.label <- rep(NA, nnode)
}
}
node.label <- unlist(lapply(node.label, function(x) gsub('/','-',x)))
node.label <- unlist(lapply(node.label, function(x) gsub('&','-',x)))
## text wrap
if(!is.null(label.wrap.width)){
width <- as.integer(label.wrap.width)
res_list <- lapply(node.label, function(x){
if(!is.na(x)){
x <- gsub('_', ' ', x)
y <- strwrap(x, width=width)
if(length(y)==2){
paste(y, collapse='\n')
}else if(length(y)>2){
#paste0(y[1], '...')
#paste0(paste(y[1:2],collapse='\n'),'...' )
paste(y,collapse='\n')
}else{
y
}
}else{
x
}
})
node.label <- unlist(res_list)
}
## node.tooltip (by default, the 'name' node attribute)
if(length(node.tooltip)!=nnode){
if(!is.null(node.tooltip)){
node.tooltip <- igraph::vertex_attr(ig, node.tooltip)
}
if(is.null(node.tooltip)){
node.tooltip <- igraph::vertex_attr(ig, 'name')
}
}
node.tooltip <- unlist(lapply(node.tooltip, function(x) gsub('/','-',x)))
node.tooltip <- unlist(lapply(node.tooltip, function(x) gsub('&','-',x)))
## node.link (by default, the 'name' node attribute)
if(length(node.link)!=nnode){
if(!is.null(node.link)){
node.link <- igraph::vertex_attr(ig, node.link)
}
if(is.null(node.link)){
node.link <- igraph::vertex_attr(ig, 'name')
}
}
## node.size (by default, 30)
if(length(node.size)!=nnode){
if(!is.null(node.size)){
tmp.node.size <- igraph::vertex_attr(ig, node.size)
#tmp.node.size <- 5 + 24 * (tmp.node.size - min(tmp.node.size)) / (max(tmp.node.size) - min(tmp.node.size))
}else{
tmp.node.size <- rep(30, nnode)
}
if(is.null(tmp.node.size)){
node.size <- rep(node.size, nnode)
}else{
node.size <- tmp.node.size
}
}
## artificially create 'name'
V(ig)$label <- V(ig)$name
V(ig)$name <- paste0('n', 1:vcount(ig))
## layout
## node.xcoord (by default, NULL)
if(length(node.xcoord)!=nnode | length(node.ycoord)!=nnode){
if(!is.null(node.xcoord)){
node.xcoord <- igraph::vertex_attr(ig, node.xcoord)
}
if(!is.null(node.ycoord)){
node.ycoord <- igraph::vertex_attr(ig, node.ycoord)
}
if(is.null(node.xcoord) | is.null(node.ycoord)){
## layout
#glayout <- igraph::layout_with_kk(ig)
glayout <- igraph::layout_as_tree(ig,root=dnet::dDAGroot(ig),circular=TRUE,flip.y=TRUE)
glayout <- glayout[,c(2:1)]
node.xcoord <- glayout[,1]
node.ycoord <- glayout[,2]
}
}
## scale into [-1,1]
if(max(node.xcoord) != min(node.xcoord)){
node.xcoord <- (node.xcoord - min(node.xcoord)) / (max(node.xcoord) - min(node.xcoord)) * 2 - 1
}
if(max(node.ycoord) != min(node.ycoord)){
node.ycoord <- (node.ycoord - min(node.ycoord)) / (max(node.ycoord) - min(node.ycoord)) * 2 - 1
}
# reverse node.ycoord
node.ycoord <- -node.ycoord
# enlarge coordinates
node.xcoord <- node.xcoord*node.coord.scale
node.ycoord <- node.ycoord*node.coord.scale
## do loop
df_nodes <- igraph::get.data.frame(ig, what="vertices")
df_nodes$node.label <- node.label
df_nodes$node.tooltip <- node.tooltip
df_nodes$node.link <- node.link
#df_nodes$node.color <- node.color
df_nodes$node.color <- paste0(node.color, 'cc')
df_nodes$node.size <- node.size
### sort: NA comes last
#df_nodes <- df_nodes[with(df_nodes,order(node.label)), ]
###
ls_nodes <- lapply(1:nrow(df_nodes), function(i){
k <- 0
vec <- vector()
k <- k+1
vec[k] <- paste0('<node id="', df_nodes$name[i], '">')
#######
if(!is.null(node.link)){
k <- k+1
#vec[k] <- paste0('<data key="d1"><![CDATA[', node.link, df_nodes$node.label[i], ']]></data>')
vec[k] <- paste0('<data key="d1"><![CDATA[', df_nodes$node.link[i],']]></data>')
}
#######
k <- k+1
vec[k] <- paste0('<data key="d2"><![CDATA[', df_nodes$node.tooltip[i], ']]></data>')
k <- k+1
vec[k] <- paste0('<data key="d3">')
k <- k+1
vec[k] <- paste0('<y:ShapeNode>')
k <- k+1
#vec[k] <- paste0('<y:Geometry height="', df_nodes$node.size[i], '" width="', df_nodes$node.size[i] ,'" x="0" y="0"/>')
#vec[k] <- paste0('<y:Geometry height="1" width="2" x="', glayout[i,1], '" y="', glayout[i,2], '"/>')
vec[k] <- paste0('<y:Geometry height="', df_nodes$node.size[i], '" width="', df_nodes$node.size[i] ,'" x="', node.xcoord[i], '" y="', node.ycoord[i], '"/>')
k <- k+1
vec[k] <- paste0('<y:Fill color="', df_nodes$node.color[i], '" transparent="false"/>')
k <- k+1
vec[k] <- paste0('<y:BorderStyle color="#dddddd" raised="false" type="line" width="1"/>')
########
k <- k+1
if(!is.na(df_nodes$node.label[i])){
vec[k] <- paste0('<y:NodeLabel alignment="center" autoSizePolicy="content" borderDistance="0.0" fontFamily="Arial" fontSize="',node.label.size,'" fontStyle="italic" hasBackgroundColor="false" hasLineColor="false" height="30" horizontalTextPosition="center" iconTextGap="4" modelName="sides" modelPosition="n" textColor="',node.label.color,'" verticalTextPosition="bottom" visible="true" width="30" x="0" y="0">', df_nodes$node.label[i], '</y:NodeLabel>')
}else{
vec[k] <- paste0('<y:NodeLabel alignment="center" autoSizePolicy="content" borderDistance="0.0" fontFamily="Arial" fontSize="',node.label.size,'" fontStyle="italic" hasBackgroundColor="false" hasLineColor="false" height="30" horizontalTextPosition="center" iconTextGap="4" modelName="sides" modelPosition="n" textColor="',node.label.color,'" verticalTextPosition="bottom" visible="false" width="30" x="0" y="0">', df_nodes$node.tooltip[i], '</y:NodeLabel>')
}
########
k <- k+1
vec[k] <- paste0('<y:Shape type="ellipse"/>')
k <- k+1
vec[k] <- paste0('</y:ShapeNode>')
k <- k+1
vec[k] <- paste0('</data>')
k <- k+1
vec[k] <- paste0('</node>')
paste(vec, collapse='\n')
})
vec_nodes <- unlist(ls_nodes)
output.nodes <- paste(vec_nodes, collapse='\n')
if(!is.null(df_legends)){
############
## legends
#############
ls_legends <- lapply(1:nrow(df_legends), function(i){
k <- 0
vec <- vector()
k <- k+1
vec[k] <- paste0('<node id="', df_legends$name[i], '">')
k <- k+1
vec[k] <- paste0('<data key="d2"><![CDATA[', df_legends$labels[i], ']]></data>')
k <- k+1
vec[k] <- paste0('<data key="d3">')
k <- k+1
vec[k] <- paste0('<y:ShapeNode>')
k <- k+1
vec[k] <- paste0('<y:Geometry height="',legend.interval*node.coord.scale,'" width="',legend.interval*node.coord.scale,'" x="', df_legends$x[i]*node.coord.scale, '" y="', df_legends$y[i]*node.coord.scale, '"/>')
k <- k+1
vec[k] <- paste0('<y:Fill color="', df_legends$colors[i], '" transparent="false"/>')
k <- k+1
vec[k] <- paste0('<y:BorderStyle color="#dddddd" raised="false" type="line" width="1"/>')
########
k <- k+1
vec[k] <- paste0('<y:NodeLabel alignment="center" autoSizePolicy="content" borderDistance="0.0" fontFamily="Arial" fontSize="',legend.label.size,'" fontStyle="plain" hasBackgroundColor="false" hasLineColor="false" height="30" horizontalTextPosition="center" iconTextGap="4" modelName="sides" modelPosition="w" textColor="#000000" verticalTextPosition="bottom" visible="true" width="30" x="0" y="0">', df_legends$labels[i], '</y:NodeLabel>')
########
k <- k+1
vec[k] <- paste0('<y:Shape type="ellipse"/>')
k <- k+1
vec[k] <- paste0('</y:ShapeNode>')
k <- k+1
vec[k] <- paste0('</data>')
k <- k+1
vec[k] <- paste0('</node>')
paste(vec, collapse='\n')
})
vec_legends <- unlist(ls_legends)
output.legends <- paste(vec_legends, collapse='\n')
}else{
output.legends <- NULL
}
############
## edges
#############
df_edges <- igraph::get.data.frame(ig, what="edges")
ls_edges <- lapply(1:nrow(df_edges), function(i){
source <- df_edges$from[i]
target <- df_edges$to[i]
k <- 0
vec <- vector()
k <- k+1
vec[k] <- paste0('<edge id="', 'e', i, '" source="', source, '" target="', target, '">')
k <- k+1
vec[k] <- paste0('<data key="d5">')
k <- k+1
vec[k] <- paste0('<y:GenericEdge configuration="DEFAULT">')
if(0){
k <- k+1
vec[k] <- paste0('<y:Path sx="0" sy="0" tx="0" ty="0"/>')
}
k <- k+1
vec[k] <- paste0('<y:LineStyle color="',edge.color,'" type="line" width="',edge.width,'"/>')
k <- k+1
if(igraph::is_directed(ig)){
vec[k] <- paste0('<y:Arrows source="none" target="standard"/>')
}else{
vec[k] <- paste0('<y:Arrows source="none" target="none"/>')
}
k <- k+1
vec[k] <- paste0('</y:GenericEdge>')
k <- k+1
vec[k] <- paste0('</data>')
k <- k+1
vec[k] <- paste0('</edge>')
paste(vec, collapse='\n')
})
vec_edges <- unlist(ls_edges)
output.edges <- paste(vec_edges, collapse='\n')
#############
## tail
#############
output.tail <- '</graph>
<data key="d6">
<y:Resources/>
</data>
</graphml>'
if(is.null(output.legends)){
output <- paste0(output.head, '\n', output.nodes, '\n', output.edges, '\n', output.tail, '\n')
}else{
output <- paste0(output.head, '\n', output.nodes, '\n', output.legends, '\n', output.edges, '\n', output.tail, '\n')
}
if(!is.null(filename)){
############################
filename <- gsub('.graphml$', '', filename)
outputfile <- paste0(filename, ".graphml")
fileConn <- base::file(outputfile)
base::writeLines(output, fileConn)
base::close(fileConn)
if(verbose){
message(sprintf("Congratulations! A file '%s' (in the directory %s) has been created!", outputfile, getwd()), appendLF=T)
}
############################
}
invisible(output)
}
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.