validateMathComb: Validate parameters specific to 'mathComb'

View source: R/validator.R

validateMathCombR Documentation

Validate parameters specific to mathComb

Description

Internal helper used by mathComb to validate mathematical-combination specific arguments. It checks the selected mathematical operator, distance metric, standardization method, transformation method, and marker-value requirements for selected transformations.

Usage

validateMathComb(
  markers,
  method = c("add", "multiply", "divide", "subtract", "distance", "baseinexp",
    "expinbase"),
  distance = c("euclidean", "manhattan", "chebyshev", "kulczynski_d", "lorentzian",
    "avg", "taneja", "kumar-johnson"),
  standardize = c("none", "min_max_scale", "zScore", "tScore", "scale_mean_to_one",
    "scale_sd_to_one"),
  transform = c("none", "log", "exp", "sin", "cos")
)

Arguments

markers

A numeric data frame or matrix containing the marker values. Marker values must be finite. If transform = "log", all marker values must be positive. If transform = "exp", transformed values must remain finite.

method

A character string specifying the mathematical combination method. Available methods are "add", "multiply", "divide", "subtract", "distance", "baseinexp", and "expinbase".

distance

A character string specifying the distance metric used when method = "distance". Available options are "euclidean", "manhattan", "chebyshev", "kulczynski_d", "lorentzian", "avg", "taneja", and "kumar-johnson". For non-distance methods, this is set to NULL.

standardize

A character string specifying the standardization method. Available options are "none", "min_max_scale", "zScore", "tScore", "scale_mean_to_one", and "scale_sd_to_one".

transform

A character string specifying the transformation applied to marker values. Available options are "none", "log", "exp", "sin", and "cos".

Value

A list containing the validated and prepared values: standardize and transform.


dtComb documentation built on June 24, 2026, 5:08 p.m.