v 1.1.1

kharchenkolab · Sep 3, 2023 · d989bfc · d989bfc
1 parent e38ed14
commit d989bfc
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 12 deletions.
diff --git a/R/RcppExports.R b/R/RcppExports.R
@@ -40,10 +40,11 @@ find_partition_rcpp <- function(edgelist, edgelist_length, num_vertices, directi
 #' library(igraph)
 #'
 #' edgelist <- as.vector(t(igraph::as_edgelist(exampleGraph, names=FALSE))) - 1
-#' edgelist_length <- length(edgelist)
-#' num_vertices <- length(igraph::V(exampleGraph)) - 1
-#' direction <- igraph::is_weighted(exampleGraph)
-#' find_partition_with_rep_rcpp(edgelist, edgelist_length, num_vertices, direction, E(exampleGraph)$weight, nrep = 10)
+#' edgelist_len <- length(edgelist)  ## The length of the graph edge list
+#' n_vertices <- length(igraph::V(exampleGraph)) - 1  ## The number of vertices in the graph
+#' direct <- igraph::is_weighted(exampleGraph)  ## Whether the graph is directed or undirected
+#' edge_weights <- E(exampleGraph)$weight
+#' find_partition_with_rep_rcpp(edgelist, edgelist_len, n_vertices, direct, edge_weights, nrep = 10)
 #'
 find_partition_with_rep_rcpp <- function(edgelist, edgelist_length, num_vertices, direction, edge_weights, resolution = 1.0, niter = 2L, nrep = 1L) {
     .Call('_leidenAlg_find_partition_with_rep_rcpp', PACKAGE = 'leidenAlg', edgelist, edgelist_length, num_vertices, direction, edge_weights, resolution, niter, nrep)

diff --git a/man/find_partition_with_rep_rcpp.Rd b/man/find_partition_with_rep_rcpp.Rd
diff --git a/src/leiden.cpp b/src/leiden.cpp
@@ -110,10 +110,11 @@ std::vector<size_t> find_partition_rcpp(std::vector<int>& edgelist, int edgelist
 //' library(igraph)
 //'
 //' edgelist <- as.vector(t(igraph::as_edgelist(exampleGraph, names=FALSE))) - 1
-//' edgelist_length <- length(edgelist)
-//' num_vertices <- length(igraph::V(exampleGraph)) - 1
-//' direction <- igraph::is_weighted(exampleGraph)
-//' find_partition_with_rep_rcpp(edgelist, edgelist_length, num_vertices, direction, E(exampleGraph)$weight, nrep = 10)
+//' edgelist_len <- length(edgelist)  ## The length of the graph edge list
+//' n_vertices <- length(igraph::V(exampleGraph)) - 1  ## The number of vertices in the graph
+//' direct <- igraph::is_weighted(exampleGraph)  ## Whether the graph is directed or undirected
+//' edge_weights <- E(exampleGraph)$weight
+//' find_partition_with_rep_rcpp(edgelist, edgelist_len, n_vertices, direct, edge_weights, nrep = 10)
 //'
 // [[Rcpp::export]]
 std::vector<size_t> find_partition_with_rep_rcpp(std::vector<int>& edgelist, int edgelist_length, int num_vertices, bool direction, std::vector<double>& edge_weights, double resolution=1.0, int niter=2, int nrep=1) {