R/read.network.R

In netresponse: Functional Network Analysis

#' Reading network files
#' 
#' Function to read network files.
#' 
#' Read in SIF network file, return R graph object in igraph or graphNEL
#' format.
#' 
#' @aliases read.sif
#' @usage read.sif(sif.file, format = 'graphNEL', directed = FALSE, header =
#' TRUE, sep = '\t', ...)
#' @param sif.file Name of network file in SIF format.
#' @param format Output format: igraph or graphNEL
#' @param directed Logical. Directed/undirected graph. Not used in the current
#' model.
#' @param header Logical. Indicate whether the SIF file has header or not.
#' @param sep Field separator.
#' @param ... Further optional arguments to be passed for file reading.
#' @return R graph object in igraph or graphNEL format.
#' @author Leo Lahti \email{leo.lahti@@iki.fi}
#' @keywords utilities
#' @examples
#' 
#' #net <- read.sif('network.sif')
#' 
read.sif <- function(sif.file, format = "graphNEL", directed = FALSE, header = TRUE, 
    sep = "\t", ...) {
    
    net <- read.csv(file = sif.file, sep = sep, colClasses = "character", header = header, 
        ...)
    
    # Assume form: node1 linktype node2 side.info..
    if (ncol(net) > 2) {
        
        # remove NA nodes
        nas <- apply(net, 1, function(x) {
            any(is.na(x[c(1, 3)]))
        })
        if (any(nas)) {
            net <- net[!nas, ]
            warning("NAs removed from network node list, ", sum(nas), " edges removed.")
        }
        
        net <- graph.edgelist(as.matrix(net[, -2]), directed = directed)
        
    } else if (ncol(net) == 2) {
        # assume form: node1 node2
        
        # remove NA nodes
        nas <- apply(net, 1, function(x) {
            any(is.na(x))
        })
        if (any(nas)) {
            net <- net[!nas, ]
            warning("NAs removed from network node list, ", sum(nas), " edges removed.")
        }
        
        net <- graph.edgelist(cbind(net[, 1], net[, 2]), directed = directed)
    }
    
    if (format == "graphNEL") {
        net <- igraph.to.graphNEL(net)
    }
    # if (format == 'igraph') { net <- igraph.from.graphNEL(igraph.to.graphNEL(net))
    # }
    
    net
}

# g <- read.graph(file, format = c('edgelist', 'pajek', 'ncol', 'lgl', 'graphml',
# 'dimacs', 'graphdb', 'gml')) FIXME: check also these; then convert graph to
# graphNEL