spearman.dist: Spearman correlational distance

spearman.distR Documentation

Spearman correlational distance

Description

Calculate pairwise Spearman correlational distances, i.e. 1-SPEAR or 1-|SPEAR|, for all rows of a matrix and return a dist object.

Usage

spearman.dist(x, ...)

Arguments

x

n by p matrix or ExpressionSet; if x is an ExpressionSet, then the function uses its 'exprs' slot.

...

arguments passed to spearman.dist:

  • absif TRUE, then 1-|SPEAR| else 1-SPEAR; default is TRUE.

  • 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 the ExpressionSet method: if TRUE (the default), then distances are computed between samples.

Details

We call cor with the appropriate arguments to compute the row-wise correlations.

Value

One minus the Spearman correlation, between rows of x, are returned, as an instance of the dist class.

Author(s)

Beiying Ding

See Also

cor.dist, tau.dist, euc, man, KLdist.matrix, KLD.matrix, mutualInfo, dist

Examples

 x <- matrix(rnorm(200), nrow = 5)
 spearman.dist(x)

Bioconductor/bioDist documentation built on Nov. 2, 2024, 7:23 a.m.