Calculate clustering metrics across gene-selection strategies
Source:R/clustering_runner.R
calculate_gene_selection_metrics.RdCalculate ARI, NMI, HOM, COM, spatial ASW, and Overall clustering agreement for each gene-selection strategy.
Usage
calculate_gene_selection_metrics(
banksy_list,
ground_truth_col = "layer_guess",
cluster_col = "banksy_cluster",
asw_max_cells = 3000,
seed = 123
)Value
Data frame containing clustering metrics and gene sets. #' @examples data(norm_example)
banksy_genes <- run_banksy_gene_selection( norm_list = norm_example, methods = names(norm_example), gene_selection = "all", assay_name = "logcounts", k_geom = 15, lambda = 0.8, resolution = 0.2, seed = 123 )
metrics_genes <- calculate_gene_selection_metrics( banksy_list = banksy_genes, ground_truth_col = "layer_guess" )
Examples
data(norm_example)
banksy_results <- run_banksy_individual(
norm_list = norm_example,
methods = names(norm_example),
assay_name = "logcounts",
cluster_col = "banksy_cluster",
k_geom = 15,
lambda = 0.8,
resolution = 0.2,
seed = 123
)
#> Computing neighbors...
#> Spatial mode is kNN_median
#> Parameters: k_geom=15
#> Done
#> Done
#> Using seed=123
#> Using seed=123
#> Computing neighbors...
#> Spatial mode is kNN_median
#> Parameters: k_geom=15
#> Done
#> Done
#> Using seed=123
#> Using seed=123
banksy_list <- list(all = banksy_results)
metrics_genes <- calculate_gene_selection_metrics(
banksy_list = banksy_list,
ground_truth_col = "layer_guess",
cluster_col = "banksy_cluster",
asw_max_cells = 3000,
seed = 123
)
head(metrics_genes)
#> method slice n ARI NMI HOM COM ASW
#> 1 None slice1 944 0.08916554 0.2532399 0.1489408 0.8449019 0.004987321
#> 2 SpaNorm slice1 944 0.08558020 0.2423588 0.1421474 0.8215048 -0.002514273
#> Overall n_asw ASW_sampled gene_selection
#> 1 0.4156942 944 FALSE all
#> 2 0.4020037 944 FALSE all