File: dicedist.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 (47 lines) | stat: -rw-r--r-- 1,312 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
\name{dicedist}
\alias{dicedist}
%- Also NEED an `\alias' for EACH other topic documented here.
\title{Dice distance matrix}
\description{
  Computes a distance derived from Dice's coincidence index
  between the columns of a 0-1-matrix.
}
\usage{
  dicedist(regmat)
}
%- maybe also `usage' for other objects documented here.
\arguments{
  \item{regmat}{0-1-matrix. Columns are species, rows are regions.}
}
\details{
  The Dice distance between two species is 1 minus the Coincidence
  Index, which is (2*number of regions where
  both species are present)/(2*number of regions where
  both species are present plus number of regions where at least one
  species is present). This is S23 in Shi (1993).
}
\value{
  A symmetrical matrix of Dice distances.
}

\references{
  Shi, G. R. (1993) Multivariate data analysis in palaeoecology and
  palaeobiogeography - a review. \emph{Palaeogeography, 
    Palaeoclimatology, Palaeoecology} 105, 199-234.
}

\author{Christian Hennig
  \email{christian.hennig@unibo.it}
  \url{https://www.unibo.it/sitoweb/christian.hennig/en}}

\seealso{
  \code{\link{kulczynski}},\code{\link{jaccard}}
}

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