Update function name add_qc_metrics in docs

LieberInstitute · May 17, 2024 · d73d19e · d73d19e
1 parent b809a20
commit d73d19e
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 8 deletions.
diff --git a/NAMESPACE b/NAMESPACE
@@ -3,6 +3,7 @@
 export(add10xVisiumAnalysis)
 export(add_images)
 export(add_key)
+export(add_qc_metrics)
 export(annotate_registered_clusters)
 export(check_modeling_results)
 export(check_sce)
@@ -25,7 +26,6 @@ export(layer_matrix_plot)
 export(layer_stat_cor)
 export(layer_stat_cor_plot)
 export(locate_images)
-export(metrics_qc)
 export(read10xVisiumAnalysis)
 export(read10xVisiumWrapper)
 export(registration_block_cor)

diff --git a/R/add_qc_metrics.R b/R/add_qc_metrics.R
@@ -26,7 +26,7 @@
 #'     spe_qc$in_tissue[spe_qc$array_col < 10] <- FALSE
 #'
 #'     ## adds QC metrics to colData of the spe
-#'     spe_qc <- add_qc_metrics()(spe_qc)
+#'     spe_qc <- add_qc_metrics(spe_qc)
 #'     colData(spe_qc)
 #'
 #'     ## visualize edge spots
@@ -43,7 +43,7 @@
 #'     vis_clus(spe_qc, sampleid = "151507", clustervar = "scran_low_lib_size_edge")
 #' }
 #' 
-add_qc_metrics() <- function(spe) {
+add_qc_metrics <- function(spe) {
     stopifnot("in_tissue" %in% colnames(colData(spe)))
     stopifnot("sum_umi" %in% colnames(colData(spe)))
     stopifnot("sum_gene" %in% colnames(colData(spe)))

diff --git a/man/metrics_qc.Rd → man/add_qc_metrics.Rd b/man/metrics_qc.Rd → man/add_qc_metrics.Rd