Expand documentation for find_gene_modules() random_seed parameter.

cole-trapnell-lab · Oct 31, 2023 · a72a61b · a72a61b
1 parent 3204b6c
commit a72a61b
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/R/cluster_genes.R b/R/cluster_genes.R
@@ -19,6 +19,8 @@
 #'   so, this method will evaluate modularity at each resolution and use the
 #'   one with the highest value.
 #' @param random_seed  the seed used by the random number generator in Leiden.
+#'   The default value is 0L, which uses a random seed. For reproducible results,
+#'   set random_seed to a positive integer.
 #' @param cores number of cores computer should use to execute function
 #' @param verbose Whether or not verbose output is printed.
 #' @param preprocess_method a string specifying the low-dimensional space

diff --git a/man/find_gene_modules.Rd b/man/find_gene_modules.Rd