File: qkulczynski.Rd

package info (click to toggle)
r-cran-prabclus 2.3-2-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye
  • size: 1,392 kB
  • sloc: sh: 13; makefile: 2
file content (54 lines) | stat: -rw-r--r-- 1,595 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
\name{qkulczynski}
\alias{qkulczynski}
%- Also NEED an `\alias' for EACH other topic documented here.
\title{Quantitative Kulczynski distance matrix}
\description{
  Computes quantitative Kulczynski distances between the columns of an
  abundance matrix.
}
\usage{
qkulczynski(regmat, log.distance=FALSE)
}
%- maybe also `usage' for other objects documented here.
\arguments{
  \item{regmat}{(non-negative) abundance matrix. Columns are species,
    rows are regions.}
  \item{log.distance}{logical. If \code{TRUE}, 1 is added to the
    abundance matrix and then the logs of the values are taken in order
    to compute the distance.}
}
\details{
  The quantitative Kulczynski distance between two species
  is 1-(mean of (mean of over regions minimum abundance of both
  species)/(sum of abundances of species 1) and (mean of over regions
  minimum abundance of both species)/(sum of abundances of species 2)).
  If the abundance matrix is a 0-1-matrix, this gives the standard
  Kulczynski distance.
}
\value{
  A symmetrical matrix of quantitative Kulczynski distances.
}

\references{
  D. P. Faith, P. R. Minchin and L. Belbin (1987) Compositional
  dissimilarity as a robust measure of ecological distance.
  \emph{Vegetation} 69, 57-68.
  }
  
\author{Christian Hennig
  \email{christian.hennig@unibo.it}
  \url{https://www.unibo.it/sitoweb/christian.hennig/en}}


\seealso{
  \code{\link{kulczynski}}
}

\examples{
options(digits=4)
data(kykladspecreg)
qkulczynski(t(kykladspecreg))
}
\keyword{cluster}% at least one, from doc/KEYWORDS
\keyword{spatial}% __ONLY ONE__ keyword per line