R/summary_graph.R

In Issamfalih/ANCL: Attributed Network Clustering Library

#' summary graph
#'
#' @description The summary of the input graph
#' @usage summary.graph(graph)
#' @param graph : an igraph graph
#' @return A list of graph description
#' @author  Issam Falih <issam.falih@lipn.univ-paris13.fr>
#' @examples
#' g = graph.famous("Zachary")
#' summary.graph(g)
#' @export


summary.graph <- function(graph){

  if(!is.igraph(graph))
    stop("Graph should be an igraph graph")

  str = paste("Number of nodes : ",vcount(graph),"\n",
                "Number of edges : ",ecount(graph),"\n",
                "Graph density : ",round(graph.density(graph),4),"\n",
                #"Graph diameter : ",diameter(graph),"\n",
                "Graph transitivity : ",round(transitivity(graph),4),"\n",
                "average degree : ",mean(degree(graph)),"\n",
                "min degree : ",min(degree(graph)),"\n",
                "max degree : ",max(degree(graph)),"\n"
               #"Graph transitivity : ",round(transitivity(graph),4),"\n"
               )
  if(!is.connected(graph)){
      str = paste0(str ,"The graph is unconnected ","\n \t",
                        "Number of connected components : ",clusters(graph)$no,"\n\t",
                        "Greastest connected component length : ", sort(clusters(graph)$csize, decreasing = TRUE)[1],
                        " it represents ",round(sort(clusters(graph)$csize, decreasing = TRUE)[1]/vcount(graph) * 100,2)," of graph size" ,"\n")
      }
    return(str)
}