File: crmatrix.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,326 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{crmatrix}
\alias{crmatrix}
%- Also NEED an `\alias' for EACH other topic documented here.
\title{Region-wise cluster membership}
\description{
  Produces a matrix with clusters as rows and regions as columns,
  indicating how many species present in a region belong to the clusters
}
\usage{
crmatrix(x,xc,percentages=FALSE)

}
%- maybe also `usage' for other objects documented here.
\arguments{
  \item{x}{object of class \code{prab} as
    generated by \code{prabinit}. Presence-absence data to be analyzed.}
  \item{xc}{object of class \code{prabclust} or \code{comprabclust}
    as generated by \code{prabclust} or \code{hprabclust}. The
    clustering.}
  \item{percentages}{logical. If \code{TRUE}, the output matrix will
    give the proportion of species from a certain region in the cluster.}
}

\value{
  A clusters time regions matrix as explained above.
}
\author{Christian Hennig
  \email{christian.hennig@unibo.it}
  \url{https://www.unibo.it/sitoweb/christian.hennig/en}
}

\examples{
\donttest{
  options(digits=3)
  data(kykladspecreg)
  data(nb)
  set.seed(1234)
  x <- prabinit(prabmatrix=kykladspecreg, neighborhood=nb)
  xc <- prabclust(x)

  crmatrix(x,xc)
  crmatrix(x,xc, percentages=TRUE)
}
}

\keyword{spatial}% at least one, from doc/KEYWORDS
\keyword{cluster}% __ONLY ONE__ keyword per line