applicable_metrics: Which Decomposition Metrics Apply to Which Algorithm

View source: R/decomp_metrics.R

applicable_metricsR Documentation

Which Decomposition Metrics Apply to Which Algorithm

Description

Derived from decomposition_traits and the metric registry: a metric applies to an algorithm when every trait it requires is TRUE for that algorithm.

Usage

applicable_metrics(algorithm = NULL)

Arguments

algorithm

Optional Character: Name of a decomposition algorithm, matched case-insensitively. NULL returns the full derived matrix.

Details

Nothing here is maintained per algorithm. reconstruction_rmse requires invertible, so it is defined for PCA, ICA and NMF and undefined for tSNE, UMAP and Isomap; max_abs_component_correlation requires nothing, so it is defined everywhere. An algorithm added to decom_algorithms with a correct traits row inherits the right metric set without any edit to the metrics code.

Value

data.frame. With algorithm, the registry rows that apply to it: one row per metric, with its group, requirements, whether it needs new data, direction and range. With NULL, one row per metric and one logical column per algorithm.

Author(s)

EDG

Examples

# Every metric, and which algorithms support it
applicable_metrics()
# What can be computed for a UMAP embedding, which does not invert
applicable_metrics("UMAP")

rtemis documentation built on Oct. 20, 2026, 1:06 a.m.