within_batch_ari_from_pcs: Calculate within-batch ARI using provided PCs for use in...

In AlexsLemonade/scpcaTools: Single cell data tools for ScPCA

Calculate within-batch ARI using provided PCs for use in integration metric calculations

Description

Calculate within-batch ARI using provided PCs for use in integration metric calculations

Usage

within_batch_ari_from_pcs(
  individual_sce_list,
  merged_sce,
  pc_name,
  batch_column = "library_id",
  cell_id_column = "cell_id",
  BLUSPARAM = bluster::NNGraphParam(cluster.fun = "louvain", type = "jaccard"),
  ...
)

Arguments

individual_sce_list	A named list of individual SCE objects. It is assumed these have a reduced dimension slot with principal components named "PCA". Column names of each object should match the contents of the 'cell_id_column' for the 'merged_sce.'
merged_sce	The merged SCE object containing data from multiple batches
pc_name	The name used to access the PCA results stored in the SingleCellExperiment object
batch_column	The variable in 'merged_sce' indicating the grouping of interest. Generally this is either batches or cell types. Default is "library_id".
cell_id_column	The variable in 'merged_sce' indicating the original cell barcode. Default is "cell_id".
BLUSPARAM	A BlusterParam object specifying the clustering algorithm to use and any additional clustering options. Default is 'bluster::NNGraphParam(cluster.fun = "louvain", type = "jaccard")'
...	Additional arguments to provide to 'bluster::clusterRows()' within 'cluster_sce()'

Value

Tibble with three columns: 'ari', representing the calculated ARI values; 'batch_id', the batch id associated with each 'ari'; 'pc_name', the name associated with the pc results

AlexsLemonade/scpcaTools documentation built on July 12, 2024, 8:34 a.m.