R/plotPairwiseDistancesDensity.R
plotPairwiseDistancesDensity.Rd
Calculates pairwise distances or correlations between query and reference cells of a specific cell type.
A SingleCellExperiment
containing the single-cell
expression data and metadata.
A SingleCellExperiment
object containing the single-cell
expression data and metadata.
The column name in the colData
of query_data
that identifies the cell types.
The column name in the colData
of reference_data
that identifies the cell types.
The query cell type for which distances or correlations are calculated.
The reference cell type for which distances or correlations are calculated.
A numeric vector specifying which principal components to use in the analysis. Default is 1:5.
If set to NULL
then no dimensionality reduction is performed and the assay data is used directly for computations.
The distance metric to use for calculating pairwise distances, such as euclidean, manhattan etc. Set it to "correlation" for calculating correlation coefficients.
The correlation method to use when distance_metric is "correlation". Possible values: "pearson", "spearman".
Name of the assay on which to perform computations. Default is "logcounts".
A plot generated by ggplot2
, showing the density distribution of
calculated distances or correlations.
The function works with SingleCellExperiment
objects, ensuring
compatibility with common single-cell analysis workflows. It subsets the data for specified cell types,
computes pairwise distances or correlations, and visualizes these measurements using density plots. By comparing the distances and correlations,
one can evaluate the consistency and reliability of annotated cell types within single-cell datasets.
# Load data
data("reference_data")
data("query_data")
# Example usage of the function
plotPairwiseDistancesDensity(query_data = query_data,
reference_data = reference_data,
query_cell_type_col = "SingleR_annotation",
ref_cell_type_col = "expert_annotation",
cell_type_query = "CD8",
cell_type_ref = "CD8",
pc_subset = 1:5,
distance_metric = "euclidean",
correlation_method = "pearson")