convert_to_dist: Convert a similarity or distance matrix to a 'dist' object

View source: R/convert_to_dist.R

convert_to_distR Documentation

Convert a similarity or distance matrix to a 'dist' object

Description

This function converts a similarity matrix (with values between 0 and 1 and 1s on the diagonal) or a distance matrix into a 'dist' object. The user can specify the method used to transform similarity values into distances.

Usage

convert_to_dist(dist_mat, similarity_transform = c("linear", "sqrt"))

Arguments

dist_mat

A square matrix (similarity or distance) or a 'dist' object.

similarity_transform

Method to convert similarity to distance. Either "linear" (default) or "sqrt".

  • "linear": Applies a linear transformation to convert similarity to distance.

  • "sqrt": Applies the square root transformation to convert similarity to distance.

Value

An object of class 'dist'.


dbrobust documentation built on Nov. 5, 2025, 6:24 p.m.