dist_sigs_2_mean {qfasar} | R Documentation |
Distance between fatty acid signatures and their mean
Description
The utility function dist_sigs_2_mean
computes the summed and mean
distance between a collection of fatty acid signatures and their mean
signature.
Usage
dist_sigs_2_mean(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
A list containing the following elements:
- dist_sum
The summed distance between each signature and the mean signature.
- dist_mean
The mean distance between each signature and the mean signature.
Details
This 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 is performed. Please
refer to the documentation for prep_sig
for additional
information.
Please refer to the documentation for dist_between_2_sigs
for
additional information regarding distance measures.
Utility functions called by dist_sigs_2_mean
: