dist_sum_pairwise: Distance between pairs of fatty acid signatures

Description Usage Arguments Value Details

View source: R/dist_sum_pairwise.R

Description

The utility function dist_sum_pairwise computes the total distance between all possible pairs of fatty acid signatures.

Usage

1
dist_sum_pairwise(sig_data, dist_meas = 1, gamma = 1)

Arguments

sig_data

A numeric matrix of fatty acid signatures in column-major format.

dist_meas

An integer indicator of the distance measure to compute. Default value 1.

gamma

The power parameter of the chi-square distance measure. Default value 1.

Value

The summed distance between all possible pairs of signatures.

Details

dist_sum_pairwise is an internal utility function. The signature data in sig_data are presumed to be ready for analysis, which is best accomplished by a call to the function prep_sig. Consequently, to increase execution speed during simulations, no numeric error checking of the signatures is performed. Please refer to documentation for the function prep_sig for information regarding signature preparation.

Please refer to documentation for the function dist_between_2_sigs for additional information regarding the arguments dist_meas and gamma.

Utility functions called by dist_sigs_2_mean:


qfasar documentation built on March 20, 2020, 1:10 a.m.