spelling & wording updates

Author: jashapiro

R/calculate-clusters.R

@@ -15,7 +15,7 @@
 #' @param algorithm Clustering algorithm to use. Must be one of "louvain" (default), "walktrap", or "leiden".
 #' @param weighting Weighting scheme to use. Must be one of "jaccard" (default), "rank", or "number"
 #' @param nn Number of nearest neighbors. The default is 10.
-#' @param resolution Resolution parameter used by louvain and leiden clustering only. Default is 1.
+#' @param resolution Resolution parameter used by Louvain and Leiden clustering only. Default is 1.
 #' @param objective_function Leiden-specific parameter for whether to use the Constant Potts Model ("CPM"; default)
 #'   or "modularity"
 #' @param cluster_args List of additional arguments to pass to the chosen clustering function.
@@ -50,15 +50,15 @@
 #' # cluster directly from a matrix using default parameters
 #' cluster_df <- calculate_clusters(pca_matrix, seed = 11)
 #'
-#' # cluster directly from a matrix using the leiden algorithm with a resolution of 0.1
+#' # cluster directly from a matrix using the Leiden algorithm with a resolution of 0.1
 #' cluster_df <- calculate_clusters(
 #'   pca_matrix,
 #'   algorithm = "leiden",
 #'   resolution = 0.1,
 #'   seed = 11
 #' )
 #'
-#' # cluster directly from a matrix using the leiden algorithm with 3 iterations
+#' # cluster directly from a matrix using the Leiden algorithm with 3 iterations
 #' cluster_df <- calculate_clusters(
 #'   pca_matrix,
 #'   algorithm = "leiden",
@@ -71,8 +71,8 @@ calculate_clusters <- function(
     algorithm = c("louvain", "walktrap", "leiden"),
     weighting = c("jaccard", "rank", "number"),
     nn = 10,
-    resolution = 1, # louvain or leiden
-    objective_function = c("CPM", "modularity"), # leiden only
+    resolution = 1, # Louvain or Leiden
+    objective_function = c("CPM", "modularity"), # Leiden only
     cluster_args = list(),
     threads = 1,
     seed = NULL,
@@ -157,15 +157,15 @@ calculate_clusters <- function(
 #'
 #' This function first determines if the provided object is a SingleCellExperiment or
 #' Seurat object, and then extract the PC matrix. If no name for the PC matrix is provided,
-#' this function will assume the name of "PCA" for SingleCellExperiment objects, and
+#' this function will use "PCA" for SingleCellExperiment objects, and
 #' "pca" for Seurat objects.
 #'
 #' @import SingleCellExperiment
 #' @import methods
 #'
 #' @param sc_object Either a SingleCellExperiment or Seurat object
 #' @param pc_name Optionally, the name of the PC matrix in the object. If this is
-#' not provided, the name "PCA" is assumed for SingleCellExperiment objects, and
+#' not provided, the name "PCA" is used for SingleCellExperiment objects, and
 #' "pca" for Seurat objects.
 #'
 #' @return PC matrix with row names
@@ -174,13 +174,13 @@ calculate_clusters <- function(
 #'
 #' @examples
 #' \dontrun{
-#' # extract PC matrix from SCE object, assuming default name "PCA"
+#' # extract PC matrix from SCE object, using default name "PCA"
 #' pca_matrix <- extract_pc_matrix(sce_object)
 #'
 #' # extract PC matrix from SCE object with non-default name "PCA_MAT"
 #' pca_matrix <- extract_pc_matrix(sce_object, pc_name = "PCA_MAT")
 #'
-#' # extract PC matrix from Seurat object, assuming default name "pca"
+#' # extract PC matrix from Seurat object, using default name "pca"
 #' pca_matrix <- extract_pc_matrix(seurat_object)
 #' }
 extract_pc_matrix <- function(sc_object, pc_name = NULL) {
@@ -233,7 +233,7 @@ extract_pc_matrix <- function(sc_object, pc_name = NULL) {
 #'  or Seurat object containing PCs. If a matrix is provided, rows should be cells
 #'  and columns should be PCs, and row names should be cell ids (e.g., barcodes).
 #' @param pc_name Optionally, the name of the PC matrix in the object. Not used for
-#'   matrices. If this is not provided, the name "PCA" is assumed for
+#'   matrices. If this is not provided, the name "PCA" is used for
 #'   SingleCellExperiment objects, and "pca" for Seurat objects.
 #'
 #' @return A matrix of PCs with row names representing cell ids

R/sweep-clusters.R

@@ -11,7 +11,7 @@
 #' For each algorithm specified, all parameters possible to use with that
 #' algorithm will be systematically varied. This function does not accept additional
 #' parameters besides those listed above.
-#' Note that defaults for some arguments may differ from the bluster::NNGraphParam() defaults.
+#' Note that defaults for some arguments may differ from the `bluster::NNGraphParam()` defaults.
 #' Specifically, the clustering algorithm defaults to "louvain" and the weighting scheme to "jaccard"
 #' to align with common practice in scRNA-seq analysis.
 #'
@@ -25,7 +25,7 @@
 #'   "rank", or "number"
 #' @param nn Number of nearest neighbors to consider when sweeping parameters.
 #'  Provide a vector of unique values to vary this parameter. The default is 10.
-#' @param resolution Resolution parameter used by louvain and leiden clustering only.
+#' @param resolution Resolution parameter used by Louvain and Leiden clustering only.
 #'   Provide a vector of unique values to vary this parameter. The default is 1.
 #' @param objective_function Leiden-specific parameter for whether to use the
 #'   Constant Potts Model ("CPM"; default) or "modularity". Provide a vector of unique values
@@ -39,22 +39,22 @@
 #' @return A list of data frames from performing clustering across all parameter combinations.
 #'   Columns include `cluster_set` (identifier column for results from a single clustering run),
 #'   `cell_id`, and `cluster`. Additional columns represent algorithm parameters and include at least:
-#'   `algorithm`, `weighting`, and `nn`. Louvain and leiden clustering will also include `resolution`,
-#'   and leiden clustering will further include `objective_function`.
+#'   `algorithm`, `weighting`, and `nn`. Louvain and Leiden clustering will also include `resolution`,
+#'   and Leiden clustering will further include `objective_function`.
 #'
 #' @export
 #'
 #' @examples
 #' \dontrun{
-#' # perform louvain clustering with jaccard weighting (defaults),
+#' # perform Louvain clustering with Jaccard weighting (defaults),
 #' # varying the nearest neighobor parameter, and set a seed for reproducibility
 #' cluster_df <- sweep_clusters(
 #'   sce_object,
 #'   nn = c(10, 15, 20, 25),
 #'   seed = 11
 #' )
 #'
-#' # perform louvain clustering, with jaccard and rank weighting, and
+#' # perform Louvain clustering, with Jaccard and rank weighting, and
 #' # varying the nearest neighbor and resolution parameters.
 #' cluster_df <- sweep_clusters(
 #'   sce_object,
@@ -65,8 +65,8 @@
 #'   seed = 11
 #' )
 #'
-#' # perform walktrap and louvain clustering with jaccard weighting, and
-#' # varying the nearest neighbors for both algorithms, and resolution for louvain.
+#' # perform walktrap and Louvain clustering with Jaccard weighting, and
+#' # varying the nearest neighbors for both algorithms, and resolution for Louvain.
 #' cluster_df <- sweep_clusters(
 #'   sce_object,
 #'   algorithm = c("walktrap", "louvain"),
@@ -81,8 +81,8 @@ sweep_clusters <- function(
     algorithm = "louvain",
     weighting = "jaccard",
     nn = 10,
-    resolution = 1, # louvain or leiden
-    objective_function = "CPM", # leiden only
+    resolution = 1, # Louvain or Leiden
+    objective_function = "CPM", # Leiden only
     threads = 1,
     seed = NULL,
     pc_name = NULL) {