File: make_clusters.Rd

package info (click to toggle)
r-cran-igraph 2.2.2-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 27,772 kB
  • sloc: ansic: 206,420; cpp: 21,827; fortran: 4,090; yacc: 1,229; lex: 518; sh: 52; makefile: 8
file content (75 lines) | stat: -rw-r--r-- 2,077 bytes parent folder | download
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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/community.R
\name{make_clusters}
\alias{make_clusters}
\title{Creates a communities object.}
\usage{
make_clusters(
  graph,
  membership = NULL,
  algorithm = NULL,
  merges = NULL,
  modularity = TRUE
)
}
\arguments{
\item{graph}{The graph of the community structure.}

\item{membership}{The membership vector of the community structure, a
numeric vector denoting the id of the community for each vertex. It
might be \code{NULL} for hierarchical community structures.}

\item{algorithm}{Character string, the algorithm that generated
the community structure, it can be arbitrary.}

\item{merges}{A merge matrix, for hierarchical community structures (or
\code{NULL} otherwise.}

\item{modularity}{Modularity value of the community structure. If this
is \code{TRUE} and the membership vector is available, then it the
modularity values is calculated automatically.}
}
\value{
A \code{communities} object.
\describe{
\item{membership}{
A numeric vector giving the community id for each vertex.
}
\item{modularity}{
The modularity score of the partition.
}
\item{algorithm}{
If known, the algorithm used to obtain the communities.
}
\item{vcount}{
Number of vertices in the graph.
}
}
}
\description{
This is useful to integrate the results of community finding algorithms
that are not included in igraph.
}
\seealso{
Community detection
\code{\link{as_membership}()},
\code{\link{cluster_edge_betweenness}()},
\code{\link{cluster_fast_greedy}()},
\code{\link{cluster_fluid_communities}()},
\code{\link{cluster_infomap}()},
\code{\link{cluster_label_prop}()},
\code{\link{cluster_leading_eigen}()},
\code{\link{cluster_leiden}()},
\code{\link{cluster_louvain}()},
\code{\link{cluster_optimal}()},
\code{\link{cluster_spinglass}()},
\code{\link{cluster_walktrap}()},
\code{\link{compare}()},
\code{\link{groups}()},
\code{\link{membership}()},
\code{\link{modularity.igraph}()},
\code{\link{plot_dendrogram}()},
\code{\link{split_join_distance}()},
\code{\link{voronoi_cells}()}
}
\concept{community}