1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
|
#' Coerce an object to class "igraph"
#'
#' Coerce objects to class "igraph".
#'
#' \code{asIgraph} is a generic function with methods written for data frames
#' and objects of class "network".
#'
#' If \code{x} is a data frame, the method used is a wrapper around
#' \code{\link[igraph]{graph.data.frame}} in package \pkg{igraph}. The
#' \code{vnames} argument was added so that the user can specify which vertex
#' attribute from the data frame supplied through \code{vertices} argument is
#' used for vertex names (the \code{name} attribute in \code{igraph} objects) in
#' the returned result. By default the vertex names are not created.
#'
#' If \code{x} is of class "network" (package \pkg{network}) the function
#' uses \code{\link{asDF}} to extract data on edges and vertex with their
#' attributes (if present). Network attributes are extracted as well. Not all
#' vertex/edge/network attributes are worth preserving though. Attributes are
#' copied, dropped or renamed based on rules given in the \code{amap}
#' argument, see \code{\link{attrmap}} for details. The function currently does
#' not support objects that represent neither bipartite networks nor
#' hypergraphs.
#'
#' @param x R object to be converted
#' @param directed logical, whether the created network should be directed
#' @param amap data.frame with attribute copy/rename rules, see
#' \code{\link{attrmap}}
#' @param vertices NULL or data frame, optional data frame containing vertex
#' attributes
#' @param vnames character, name of the column in \code{vertices} to be used as
#' a \code{name} vertex attribute, if \code{NULL} no vertex names are created
#' @param \dots other arguments from/to other methods
#'
#' @return Object of class "igraph".
#'
#' @seealso \code{\link[igraph]{graph.data.frame}}
#'
#' @export
#'
#' @example examples/asIgraph.R
#'
asIgraph <- function(x, ...) UseMethod("asIgraph")
#' @method asIgraph network
#' @export
#' @rdname asIgraph
asIgraph.network <- function(x, amap=attrmap(), ...)
{
object <- x
# hypergraphs not supported
if(network::is.hyper(object))
stop("hypergraphs are not supported")
if(network::is.bipartite(object))
stop("bipartite networks are not supported")
na <- dumpAttr(object, "network")
l <- asDF(object)
### prepare edge attributes
eats <- attrmapmat("network", "igraph", "edge", db=amap)
# drop some
todrop <- eats[ is.na(eats[,"toattr"]) , "fromattr" ]
edges <- l$edges[ !( names(l$edges) %in% todrop ) ]
# rename some
names(edges) <- recode(names(edges), eats)
### prepare vertex attributes
vats <- attrmapmat("network", "igraph", "vertex", db=amap)
# drop some
todrop <- vats[ is.na(vats[,"toattr"]) , "fromattr" ]
vertexes <- l$vertexes[ !( names(l$vertexes) %in% todrop ) ]
# rename some
names(vertexes) <- recode(names(vertexes), vats)
### make 'igraph' object
rval <- asIgraph( edges,
directed=network::is.directed(object),
vertices=vertexes, ...)
### apply/rename/drop network attributes
nats <- attrmapmat("network", "igraph", "network", db=amap)
todrop <- nats[ is.na(nats[,"toattr"]) , "fromattr" ]
na <- na[ - which( names(na) %in% todrop ) ]
names(na) <- recode(names(na), nats)
if( length(na) > 0 )
{
for( naname in names(na) )
rval <- igraph::set_graph_attr(rval, naname, na[[naname]])
}
rval
}
#' @method asIgraph data.frame
#' @export
#' @rdname asIgraph
asIgraph.data.frame <- function(x, directed=TRUE, vertices=NULL, vnames=NULL, ...)
{
object <- x
rval <- igraph::graph_from_data_frame( object, directed=directed,
vertices=vertices)
if(is.null(vnames))
{
rval <- igraph::delete_vertex_attr(rval, "name")
} else
{
if( !(vnames %in% names(vertices)) )
stop("no column ", vnames, " in 'vertices'")
rval <- igraph::set_vertex_attr(rval, "name", value=vertices[[vnames]])
}
rval
}
|
