diff --git a/R/community.R b/R/community.R index fb6d9f40070..fd9abd48e7b 100644 --- a/R/community.R +++ b/R/community.R @@ -550,8 +550,13 @@ print.communities <- function(x, ...) { #' is `TRUE` and the membership vector is available, then it the #' modularity values is calculated automatically. #' @return A `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.} +#' } #' @family community #' @export make_clusters <- function(graph, membership = NULL, algorithm = NULL, diff --git a/R/topology.R b/R/topology.R index a166925b0cd..808f89eee20 100644 --- a/R/topology.R +++ b/R/topology.R @@ -775,7 +775,6 @@ graph.isoclass <- isoclass_impl #' @return An igraph object, the graph of the given size, directedness #' and isomorphism class. #' -#' #' @family graph isomorphism #' @export #' @cdocs igraph_isoclass_create diff --git a/man/make_clusters.Rd b/man/make_clusters.Rd index 8724d798b5a..be323fb60fb 100644 --- a/man/make_clusters.Rd +++ b/man/make_clusters.Rd @@ -31,6 +31,13 @@ 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