nmi: Normalized mutual information (NMI)

Description Usage Arguments Value Examples

View source: R/metrics.R

Description

A function to compute the NMI between two classifications

Usage

1
nmi(c1, c2, variant = c("max", "min", "sqrt", "sum", "joint"))

Arguments

c1

a vector containing the labels of the first classification. Must be a vector of characters, integers, numerics, or a factor, but not a list.

c2

a vector containing the labels of the second classification.

variant

a string in ("max", "min", "sqrt", "sum", "joint"): different variants of NMI. Default use "max".

Value

a scalar with the normalized mutual information .

Examples

1
2
3
 ## calculate Normalized Mutal Information score for two sets of labels
 data(sceiad_subset_data)
 nmi(sceiad_subset_data$CellType_predict, sceiad_subset_data$cluster)

scPOP documentation built on Aug. 4, 2021, 5:06 p.m.

Related to nmi in scPOP...