KLD.matrix: Continuous version of Kullback-Leibler Distance (KLD)

KLD.matrixR Documentation

Continuous version of Kullback-Leibler Distance (KLD)

Description

Calculate KLD by estimating by smoothing \log(f(x)/g(x))*f(x) and then integrating.

Usage

KLD.matrix(x, ...) 

Arguments

x

n by p matrix or list or an object of a class that extends eSet; if x is an an object of a class that extends eSet (eg ExpressionSet), then the function works against its 'exprs' slot.

...

arguments passed to KLD.matrix:

  • methoduse locfit or density to estimate integrand; default is c("locfit", "density")(i.e. both methods).

  • suppupper and lower limits of the integral; default is NULL in which case the limits of the integral are calculated from the range of the data.

  • subdivisionssubdivisions for the integration; default is 1000.

  • diagif TRUE, then the diagonal of the distance matrix will be displayed; default is FALSE.

  • upperif TRUE, then the upper triangle of the distance matrix will be displayed; default is FALSE.

  • samplefor ExpressionSet methods: if TRUE, then distances are computed between samples, otherwise, they are computed between genes.

Details

The distance is computed between rows of the input matrix (except if the input is an object of a class that extends eSet and sample is TRUE.

The presumption is that all samples have the same number of observations. The list method is meant for use when samples sizes are unequal.

Value

An object of class dist with the pairwise, between rows, Kullback-Leibler distances.

Author(s)

Beiying Ding, Vincent Carey

See Also

cor.dist, spearman.dist, tau.dist, dist, KLdist.matrix, mutualInfo

Examples

 x <- matrix(rnorm(100), nrow = 5)
 KLD.matrix(x, method = "locfit", supp = range(x))

Bioconductor/bioDist documentation built on Oct. 29, 2023, 5:04 p.m.