distvar: Calculates the distance variance

In jofie/DistCov: Functions for distance correlations

Description

Calculates the distance variance

Usage

distvar(X, affine = FALSE, bias.corr = TRUE, type.X = "sample",
  metr.X = "euclidean", use = "all")

Arguments

X	contains either the first sample or its corresponding distance matrix. In the first case, this input can be either a vector of positive length, a matrix with one column or a data.frame with one column. In this case, type.X must be specified as "sample". In the second case, the input must be a distance matrix corresponding to the sample of interest. In this second case, type.X must be "distance".
affine	logical; indicates if the affinely transformed distance variance should be calculated or not.
bias.corr	logical; indicates if the bias corrected version of the sample distance variance should be calculated.
type.X	either "sample" or "distance"; specifies the type of input for X.
metr.X	specifies the metric which should be used for X to analyse the distance variance TO DO: Provide details for this.
use	: "all" uses all observations, "complete.obs" excludes NA's

Value

numeric giving the distance variance of the sample X..

jofie/DistCov documentation built on May 23, 2019, 9:02 p.m.